[sf.cmath] contains superfluous "Effects:"-clauses
Nobody has claimed this yet.
- Dominant language
- TeX
- Stars
- 221
- Forks
- 813
- Avg merge
- 16h 4m
- Merged PRs (30d)
- 36
Description
For example: https://eel.is/c++draft/sf.cmath.riemann.zeta#1
This "Effects:"-clause doesn't specify anything that isn't already specified by the "Returns:"-clause that immediately follows it. If anything, this "Effects:"-clause sounds like an informal commentary on the intentions of the "Returns:"-clause.
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
Start with the specification at sf.cmath.riemann.zeta#1 and inspect the surrounding source for the Effects: and Returns: clauses. Search the sf.cmath section for similarly redundant Effects: clauses, then verify that the draft no longer repeats information already stated by the corresponding Returns: clauses.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- tex
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100