Skip to content

\pnums in examples and notes are ugly and confusing #781

@burblebee

Description

@burblebee

Update: the issue with \pnums in effects/return/etc. clauses was separated out and is now issue #821.

Adding \pnums added in the middle of examples and notes makes it hard to see where the example/note starts/ends, and \pnums added in \effects (or other) clauses causes the wording to spill over into a new paragraph making it look like it's no longer part of the Effects (or other).

As an example of \pnums in an example, have a look at 27.10.8.6.2 [path.factory]/p4 - it has new paragraphs as they appeared in the original wording, but it is ugly! See also the Note above in 27.10.8.6 [path.non-member]/p8.

Inserting a blank line in the Latex before the text in the examples/notes/effects/etc. seems to work - is there a better way? In any case, I think we should fix these as we come across them. Or in one big swoop if someone has the patience.

Having examples embedded in the paragraph is ugly also - see 1.9 [intro.execution]/p16. It would be nice to address those while we're at it, perhaps also by inserting a blank line before/after the example? \linebreak doesn't work because it causes the previous line to get stretched, and \linebreak after a blank line results in an error.

Here's a few examples of embedded \pnums that I think we may want to fix:

  • \pnums in clauses:
    ** [ios.members.static]/p3
    ** [streambuf.virt.pback]/p3
    ** [istream::sentry]/p3
    ** [istream::extractors]/p7
    ** [istream::extractors]/p14
    ** [istream.unformatted]/p8
    ** [istream.unformatted]/p14
    ** [istream.unformatted]/p18
    ** [ostream.inserters.arithmetic]/p1
    ** [ostream.inserters]/p7 (this is as far as I got thru Clause 27)
  • \pnums in Examples:
    ** [path.factory]/p4
    ** [fs.op.copy]/p6
    ** [fs.op.system_complete]/p5
    ** [fs.op.temp_dir_path]/p3
  • \pnums in Notes:
    ** [path.non-member]/p8

Here's a few examples of embedded exampes/notes that I think we may want to fix:

  • examples embedded in the paragraphs:
    ** [intro.execution]/p16
  • notes embedded in the paragraphs:
    ** [path.io]/p1

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions