Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use 'subclause', not 'section'. #1585

Merged
merged 1 commit into from Nov 12, 2017
Merged

Use 'subclause', not 'section'. #1585

merged 1 commit into from Nov 12, 2017

Conversation

jensmaurer
Copy link
Member

The ISO Directives, Part 2, prescribe the term 'subclause'.

Fixes #307.

source/back.tex Outdated
\renewcommand{\preglossaryhook}{This annex lists each section label and the
corresponding section number and page number, in alphabetical order by label.\\}
\renewcommand{\preglossaryhook}{This annex lists each subclause label and the
corresponding subclause number and page number, in alphabetical order by label.\\}
Copy link
Member

Choose a reason for hiding this comment

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

These ones mean "clause or subclause". We could use "[...] lists each clause or subclause label and [...]" but perhaps there's a better way to say that?

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm going for "clause or subclause" for now.

source/back.tex Outdated
@@ -34,7 +34,7 @@ \chapter{Bibliography}
\clearpage
\input{xrefdelta}
\renewcommand{\glossaryname}{Cross references from ISO \CppXIV}
\renewcommand{\preglossaryhook}{All section labels from
\renewcommand{\preglossaryhook}{All subclause labels from
Copy link
Member

Choose a reason for hiding this comment

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

Likewise, even though we haven't removed any Clause labels yet.

source/back.tex Outdated
@@ -71,7 +71,7 @@ \chapter{Bibliography}
}

\clearpage
\renewcommand{\preindexhook}{The entries in this section are rough descriptions; exact
\renewcommand{\preindexhook}{The entries in this subclause are rough descriptions; exact
Copy link
Member

Choose a reason for hiding this comment

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

This is not a subclause, it's an index.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed.

@jensmaurer
Copy link
Member Author

Rebased and addressed review comments.

@tkoeppe
Copy link
Contributor

tkoeppe commented Jul 31, 2017

Just a random observation, because I was also working on this: in lib-intro.tex, the proposed change is problematic, because we currently say for section X:

X.1 General

This section describes Foo. Subclause X.2 describes meta-Foos, subclause X.3 describes para-Foos.

If you change the first "section" to "subclause", then the hierarchy is lost, and in fact outright misleading: "Section" is an up-reference from X.1 to X, whereas "subclause" is used as a strict in-reference. We probably need a more sophisticated approach here.

@jensmaurer
Copy link
Member Author

@tkoeppe: lib-intro.tex is rather inconsistent here. My suggestion (implemented in the patch) is to remove the "overview" sub-headings in these cases so that the overview text is at the right level. Yes, it's a "hanging paragraph" in ISO speak, but strictly speaking, these introductory sentences should not be shown as normative text anyway. Do we want to find a typographical convention other than "[ Note: ... ]" that keeps such texts readable, but makes them non-normative? Maybe some indent? Or a non-serif font? Both? (Oh, we wanted a non-serif font for the grammar.)

\pnum
This section describes how a \Cpp program gains access to the facilities of the
This subclause describes how a \Cpp program gains access to the facilities of the
Copy link
Member

Choose a reason for hiding this comment

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

How about: keep the Overview subclause, and use "Subclause \ref{using} describes" here.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed.

@@ -62,7 +62,7 @@

%%--------------------------------------------------
%% Sectioning macros.
% Each section has a depth, an automatically generated section
% Each subclause has a depth, an automatically generated subclause
Copy link
Member

Choose a reason for hiding this comment

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

I don't think this change is right. :)

Copy link
Member Author

Choose a reason for hiding this comment

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

These didn't show up in diffpdf.

% Separate sections for introductory paragraphs were removed.
\removedxref{using.overview}
\removedxref{constraints.overview}
\removedxref{conforming.overview}
Copy link
Member

Choose a reason for hiding this comment

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

I think this is now redundant.

Copy link
Member Author

Choose a reason for hiding this comment

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

Indeed. Fixed.

@jensmaurer
Copy link
Member Author

Change to [xrefdelta] reverted, as advised.

The ISO Directives, Part 2, prescribe the term 'subclause'.

Also remove overview sub-headings for non-normative
subclause overview text.

Fixes cplusplus#307.
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.

None yet

3 participants