cplusplus / cplusplus/draft

Inconsistently using plurals when defining multiple functions at once

Open
#8,775 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Here is an example of this issue in atexit [support.start.term]:

Effects: The atexit() functions ...

And:

Returns: The atexit() function ...

In the effects it uses the plural to refer to both functions at once, but in the returns it uses the singular to refer to each function individually. Other places where this issue appears are all functions in [new.delete.single] and all functions in [new.delete.array]. There may be other instances of this issue, I only checked [support].

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 by locating the wording in [support.start.term], then compare the function references in the Effects and Returns descriptions. Check the functions in [new.delete.single] and [new.delete.array], and search nearby draft sources for similar plural-versus-singular usage. Done means the descriptions consistently express whether they refer to the group or each function individually.

Written by the indexing model from the issue text.

Assessment

Tech stack
tex
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.