cplusplus / cplusplus/draft

Inconsistent "default"s in allocator requirements tables

Open
#5,347 0 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

Summary: should the "Default:" of a function specification describle the result of the function call or the definition of the function?

E.g. max_size vs select_on_container_copy_construction.

\remarks
Default: \tcode{a}

Or should max_size's Default prepend return and append ;?

Originally posted by @JohelEGP in https://github.com/cplusplus/draft/pull/5327#r815525604

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

Compare the allocator requirements table entries for max_size and select_on_container_copy_construction, then review the original discussion in pull request #5327. Determine whether each Default describes the function result or its definition, and update the affected specification tables consistently once that convention is decided.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.