Fixing grammatical errors, spelling mistakes, inconsistent syntax, etc.
- Dominant language
- Python
- Stars
- 17.3k
- Forks
- 4.6k
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 13
Description
### Describe the issue
Been using AWS and AWS CLI for 11 years. Found many (and I do mean many: hundreds upon hundreds) of various documentation issues in `examples`, mainly:
* Grammar mistakes
* Spelling mistakes
* Syntactical mistakes -- extraneous spaces, extraneous blank lines, missing EOL at EOF, etc.
* CRLF vs. LF file format variances (should really be LF in Git)
* RST file syntax variances (sometimes this matters, such as extraneous blank lines ending up in rendered documentation)
I was going to take on the task of fixing all of these, and have already written some helper scripts (for myself, not for general use) to make this task easier, alongside leveraging aspell.
However, before I put bulk effort into this, I wanted to open an Issue and discuss with whoever oversees the documentation the following 2 items:
1. The sheer volume of these issues is huge. How would you like this work done, commit and branch-wise? One commit per category (see above bullet list)? Separate branches for each category? Doesn't matter?
2. Problems/concerns with sweeping commits (as I said: several hundred changes across hundreds of files)?
3. Is this worth taking on at all? Do you care?
**Note: AI will NOT be used for this task. I am a human being vetting all of this by hand/eye.**
**I'm focused solely on `v2` branch.**
Thanks.
### Links
Pretty much everything in `awscli/examples`.
Contributor guide
Assessment
This issue has not been assessed yet.