Skip to content

[introduction] Explain "above"/"below" referencing - #9395

Open
tkoeppe wants to merge 1 commit into
cplusplus:mainfrom
tkoeppe:undated754
Open

tkoeppe wants to merge 1 commit into
cplusplus:mainfrom
tkoeppe:undated754

Conversation

@tkoeppe

@tkoeppe tkoeppe commented Nov 19, 2026

Copy link
Copy Markdown
Contributor

Addresses ISO/CS 026, 030, and 049 (C++26 DIS)

Addresses ISO/CS 026, 030, and 049 (C++26 DIS)

@jwakely jwakely left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[allocator.traits.other] seems to violate this (and so should be fixed).

@jwakely

jwakely commented Nov 19, 2026

Copy link
Copy Markdown
Member

[variant.assign] refers to something two subclauses earlier.

@jwakely

jwakely commented Nov 19, 2026

Copy link
Copy Markdown
Member

I assume it's clear that "digits above 9" in [tab:format.type.int] isn't convered by this.

@jwakely

jwakely commented Nov 19, 2026

Copy link
Copy Markdown
Member

We should remote this from [fs.op.status]:

Returns: See above.

The effects has a return so it's redundant.

@jwakely

jwakely commented Nov 19, 2026 •

Copy link
Copy Markdown
Member

[fs.op.symlink.status] p1 says "Same as status, above, " which refers to an earlier subclause. It should presumably be an xref to that subclause, "Same as status ([fs.op.status])". And again in p3.

@jwakely

jwakely commented Nov 19, 2026 •

Copy link
Copy Markdown
Member

[diff.cpp20.general] says "those listed above" referring to earlier subclauses. And [diff.cpp17.general] etc.

@jwakely

jwakely commented Nov 19, 2026 •

Copy link
Copy Markdown
Member

[contracts.syn] (and several class synopses) have a see below return type, but that refers to something in a later paragraph. e.g. the destructor in [constracts.syn] is referring to [support.contract.violation] p1.

[compare.syn] similarly has see below in the synopsis but the meaning is in a later subclause. I think this is very common.

@tkoeppe

tkoeppe commented Nov 19, 2026

Copy link
Copy Markdown
Contributor Author

Thanks a lot!

@jwakely

jwakely commented Nov 19, 2026

Copy link
Copy Markdown
Member

[compare.syn] similarly has see below in the synopsis but the meaning is in a later subclause. I think this is very common.

Maybe for these ones we could add a sentence below the synopsis that says "the return type / type / whatever of blah is specified in [cmp.common]" to give a precise xref to where below it is. Then the see below in the synopsis would refer to something in the same subclause, but the actual definition would still stay more distant.

@jwakely

jwakely commented Nov 19, 2026

Copy link
Copy Markdown
Member

[concepts.syn] has a lot of see below, [cassert.syn] is a one line subclause where that one line says see below, referring the next subclause (maybe dissolve those?)

[memory.syn] does it. [pointer.traits.general] does it. [allocator.traits.general] does it. [indeirect.syn] and [polymorphoic.syn]. [alocator.adaptor.syn].

[unique.runtime.ptr.general] says using pointer = see below; and then doesn't have anything below (I think it means above, because it's copied from the primary template).

I've only got to subclause 20.7 and found all these, I think it's rife.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants