Docs: Clean up of booleans needed
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
In lots of places in the docs you have concatenations of argument and boolean, for example:
consolidateFalse
refresh_dbTrue
enabledTrue
Yes, I know the booleans are italic, but when you are skim reading, you end up in a position like I did today ... is it enabled or enabledTrue and hence do I need to set enabledTrue: False ?
The docs are also not consistent in this respect either. Some arguments show the default next to them, some (most ?) don't.
Someone really needs to find a way to tidy it up, either:
-
Come up with some magical
sed-like command that will de-concatenate the arguments from their boolean counterpart -
Get rid of all the boolean suffixes
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files or tests are named, so begin by inventorying documentation occurrences of concatenated argument names and boolean values. Review the existing inconsistency around default values, then define a consistent presentation rule; done means the affected documentation no longer makes names such as enabledTrue ambiguous.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100