cplusplus / cplusplus/draft

don't use "is called" to introduce a definition

Open
#3,515 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

We have decided to use "call" to mean a function call expression (see #3079). So we should stop using it to introduce definitions.

We should use a different phrasing to avoid this. For example, instead of:

For every iterator type X, there is a corresponding signed integer-like type called the difference type of the iterator.

Consider:

For every iterator type X, there is a corresponding signed integer-like type known as the difference type of the iterator.

Or:

The difference type of an iterator type X is a corresponding signed integer-like type, determined as specified in [incrementable.traits].

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

No source file or test is named in the issue. Search the TeX draft sources for "is called", distinguish definition-introducing uses from other meanings, and update the applicable wording using the issue's examples. Done means the relevant definitions avoid that phrasing while the draft remains consistent.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.