words-for-humans
Finds code comments and documentation that carry no information.
// This function is responsible for calculating the total price of all the items
// that are present in the cart. It's worth noting that we will iterate over each
// of the items in order to accumulate the sum of their individual prices.
export function calculateCartTotal(items: CartItem[]): number {
return items.reduce((sum, item) => sum + item.price, 0);
}
1: error [V-4] "This function is responsible for" restates the declaration below.
2: error [V-2] "It's worth noting that" adds nothing to the sentence.
3: error [V-5] "in order to" is padding.
It leaves alone the comments that say something the code cannot.
Install
uv tool install words-for-humans
Use
words-for-humans # the whole repository
words-for-humans --staged # what you are about to commit
words-for-humans --diff origin/main...HEAD # what a pull request changes
words-for-humans --write-baseline # adopt it in an existing codebase
Rules
Three families, 83 rules, 38 decided without a model.
| Family | Question |
|---|---|
1.1-9.4, GR- |
Is the sentence built the way ASD-STE100 requires? |
V- |
Does the text say anything the code does not? |
A- |
Does the text have the shape a language model produces? |
Run words-for-humans --list-rules for the catalogue.
Full documentation: https://github.com/mitchelljphayes/words-for-humans
Not affiliated with or endorsed by ASD. ASD-STE100 and Simplified Technical English are ASD's.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file words_for_humans-0.1.0.tar.gz.
File metadata
- Download URL: words_for_humans-0.1.0.tar.gz
- Upload date:
- Size: 84.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fe5648df5799e035191188a8e779b797dc2bb44fab65a19efc75739d0eb762e1
|
|
| MD5 |
d77ab6327b29563572daac98b3272635
|
|
| BLAKE2b-256 |
e961aa77232f1b2ae0f8cddc8cc7b9ba1565fa7eb45b221f90afa988d95e0074
|
Provenance
The following attestation bundles were made for words_for_humans-0.1.0.tar.gz:
Publisher:
release.yml on mitchelljphayes/words-for-humans
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
words_for_humans-0.1.0.tar.gz -
Subject digest:
fe5648df5799e035191188a8e779b797dc2bb44fab65a19efc75739d0eb762e1 - Sigstore transparency entry: 2457265466
- Sigstore integration time:
-
Permalink:
mitchelljphayes/words-for-humans@3fe19f67c651d642ebdbc8fc2cdcbf59c6b2627f -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/mitchelljphayes
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@3fe19f67c651d642ebdbc8fc2cdcbf59c6b2627f -
Trigger Event:
push
-
Statement type:
File details
Details for the file words_for_humans-0.1.0-py3-none-any.whl.
File metadata
- Download URL: words_for_humans-0.1.0-py3-none-any.whl
- Upload date:
- Size: 93.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
efa22322b8df798c2fe3a8727bc59ffa153b08ebce115750c524f1200be2a924
|
|
| MD5 |
0a97ca07f7b600d6ee64be2646e5ed7a
|
|
| BLAKE2b-256 |
b40501d158a092512e3fdcc907c93bcc054418ceddf50e1b7cef771fcfcc851c
|
Provenance
The following attestation bundles were made for words_for_humans-0.1.0-py3-none-any.whl:
Publisher:
release.yml on mitchelljphayes/words-for-humans
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
words_for_humans-0.1.0-py3-none-any.whl -
Subject digest:
efa22322b8df798c2fe3a8727bc59ffa153b08ebce115750c524f1200be2a924 - Sigstore transparency entry: 2457265682
- Sigstore integration time:
-
Permalink:
mitchelljphayes/words-for-humans@3fe19f67c651d642ebdbc8fc2cdcbf59c6b2627f -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/mitchelljphayes
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@3fe19f67c651d642ebdbc8fc2cdcbf59c6b2627f -
Trigger Event:
push
-
Statement type:
