Missing "<condition> is `true`|`false`"
Open
Nobody has claimed this yet.
big
- Dominant language
- TeX
- Stars
- 221
- Forks
- 813
- Avg merge
- 16h 4m
- Merged PRs (30d)
- 36
Description
In [utilities]. we say things like "get() == nullptr." a lot instead of "get() == nullptr is true." in many places.
We should decide whether we want to demand a specific style, and if so, document that style and fix the existing text.
Contributor guide
No contributing guide indexed for this repository
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
Review the [utilities] section and its existing wording, then read the issue's comment thread for the unresolved style discussion. Done means choosing and documenting a consistent treatment of boolean conditions, then updating all affected text in that section and checking the resulting draft for consistency.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- tex
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100