[structure] needs an overhaul
Open
Nobody has claimed this yet.
lwg
- Dominant language
- TeX
- Stars
- 221
- Forks
- 813
- Avg merge
- 16h 4m
- Merged PRs (30d)
- 36
Description
Looking through [structure], we find:
- [structure.elements] does not correctly describe any of the library clauses. There is no "Summary" subclause, no "Detailed specifications" subclause, the references to the C library are not collected together as is suggested therein. And what is an "element" anyway?
- [structure.summary]'s first sentence might be approximately correct, but the second sentence is not. And the second paragraph doesn't seem to provide any expositionary value whatsoever.
- [structure.specifications]: bullet 1.1 is not something we really do; paragraph 2 belongs on our wiki not in the working draft
- [structure.see.also] has a suspicious section name
There's lots of scope for improvements here.
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 by locating the source for [structure] and reviewing its elements, summary, specifications, and see.also subsections; compare them with the library clauses and project conventions. Done means the headings and descriptions accurately reflect the clauses, unsupported material is removed or moved to the wiki, and the suspicious section name is resolved.
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
- Mostly clear
- Newbie friendliness
- 35/100