Wholesale list of issues (with suggested fixes), as found in ISO14882:2020
Nobody has claimed this yet.
- Dominant language
- TeX
- Stars
- 221
- Forks
- 813
- Avg merge
- 16h 4m
- Merged PRs (30d)
- 36
Description
The list is extensive, therefore best viewed against the source document. The file attached contains markups importable (e.g. using Foxit PDF Reader) against PDF version of the Standard's text.
isoiec_148822020.zip
Overall methodology of used markup primitives:
- Replacements: contain text that should be substituted;
- Inserts: contain text that should be added in the pointed out locations;
- Strikeouts: candidates for removal;
- Floating notes: editorial remarks that could not be easily attached to a specific text location;
- Highlights: editorial remarks and "general thoughts" about specific text fragments.
Aside from the specific replacement/additional text each of these can contain hints/comments delimited by square brackets.
Additionally, frequently reoccurring issues, that I feel are worth mentioning as a "preface", can be put into two general categories:
- Frequently occurring issues that have been pointed out:
- using 0 in place of nullptr (e.g. in assignments and comparisons involving pointer types.);
- using sizeof(expr) instead of the (grammar appropriate) sizeof expr;
- redundant access specifiers (e.g. struct S {public:...}; class C {private:...}; struct D : public B {...}; etc.);
- places exhibiting formatting issues such as text indentation, missing whitespace etc.
- Frequently occurring issues that have been left out:
- using std::move, std::forward where move, forward would (according to context) perfectly suffice (can be easily fixed by searching/replacing using automation if need be.)
While these cannot be categorized as outright errors, I feel that fixing them would improve readability and general quality of the Standard's 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
Start by opening isoiec_148822020.zip and comparing its importable markups with the PDF version of ISO 14882:2020. Review the replacements, inserts, strikeouts, notes, and highlights in the attached material; the work is done when the agreed editorial corrections and recurring formatting issues have been addressed in the Standard's source text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- tex
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100