cplusplus / cplusplus/draft

[cpp] "identifier" should be `\grammarterm{identifier}` in more cases

Open
#6,524 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TeX
Stars
221
Forks
813
Avg merge
16h 4m
Merged PRs (30d)
36

Description

The [cpp] section talks about "identifier"s frequently; often in a context where direct statements about grammar and macro expansion are made.

It would be appropriate to use \grammarterm{identifier} in many more places. For example:

A preprocessing directive of the form

# undef identifier new-line

causes the specified identifier no longer to be defined as a macro name. It is ignored if the specified identifier is not currently defined as a macro name.

- [cpp.scope] p2

This is one of the more extreme cases: statements directly about grammar rules are made, but "identifier" is not formatted as a grammatical term.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in the [[cpp]] section and inspect the cited [[cpp.scope] p2] example. Search the draft for uses of “identifier” in passages about grammar or macro expansion, then determine which should use \grammarterm{identifier}. Done means the relevant grammatical terms are consistently formatted without changing ordinary prose.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, tex
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.