cplusplus / cplusplus/draft

always parenthesize the constraint-logical-or-expression in a requires-clause

Open
#2,504 4 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

We're starting to add requires-clauses to standard library functions, and they can quickly become pretty unreadable. For example, the Ranges proposal adds:

constexpr pointer operator->() const requires is_pointer_v<Iterator> ||
  requires (const Iterator i) { i.operator->(); };

... which makes it look like there are multiple requires-clauses or something. Add to that the fact that some requires-clauses require parentheses anyway, and the weirdness of things like

void f() noexcept(blah) requires see below;

(How much will I see below? Just a constraint, or other things that might go there, such as a function body or so?) ... and I think the only sensible and consistent formatting decision is to say that we always parenthesize the condition in a requires-clause. We should document this decision in the Wiki and apply it throughout the draft after merging the 2018-11 motions.

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

Review the 2018-11 motions and the Wiki decision, then locate requires-clauses throughout the draft. Done means the condition is consistently parenthesized and the formatting decision is documented in the Wiki.

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.