[lib] Harmonize references to standard library requirements. #1937
Conversation
jensmaurer
force-pushed
the
b23
branch
2 times, most recently
from
9fdf406
to
3892cd3
Compare
tkoeppe
added
the
needs rebase
jensmaurer
removed
the
needs rebase
|
Rebased. |
|
No need to squash, but could you move the [macros] change to the bottom so it comes first? |
|
@tkoeppe: Done. |
source/strings.tex
Outdated
| @@ -275,10 +275,10 @@ | |||
| \pnum | |||
| \requires | |||
| \tcode{state_type} | |||
| shall satisfy the requirements of | |||
| shall satisfy the | |||
| \tcode{CopyAssignable} (\tref{copyassignable}), | |||
There was a problem hiding this comment.
This is one of the few cases where the placement of the reference is acceptable, since you are listing multiple requirements. In all cases where we only say one requirement, I would much prefer the reference after the word "requirements". Otherwise it's really disrutpive: "shall satisfy the Foo (Table n) requirements." vs "shall satisfy the Foo requirements (Table n)."
We even have a lot of precedent for that placement in the many other cases where we already say " shall satisfy the Foo requirements". So it wouldn't just read better, but also be more consistent.
with 'FrobMunchable requirements'.
| @@ -13031,7 +13031,7 @@ | |||
| \indexlibrary{\idxcode{file_type}}% | |||
| \pnum | |||
| This enum class specifies constants used to identify file types, | |||
| with the meanings listed in Table~\ref{tab:fs.enum.file_type}. | |||
| with the meanings listed in Table~\tref{fs.enum.file_type}. | |||
There was a problem hiding this comment.
@jensmaurer: Extraneous "Table" here.
| @@ -13074,7 +13074,7 @@ | |||
| \pnum | |||
| The \tcode{enum class} type \tcode{copy_options} | |||
| is a bitmask type\iref{bitmask.types} that specifies bitmask constants used to control the semantics of | |||
| copy operations. The constants are specified in option groups with the meanings listed in Table~\ref{tab:fs.enum.copy_options}. | |||
| copy operations. The constants are specified in option groups with the meanings listed in Table~\tref{fs.enum.copy_options}. | |||
There was a problem hiding this comment.
Another extraneous "Table".
| @@ -13074,7 +13074,7 @@ | |||
| \pnum | |||
| The \tcode{enum class} type \tcode{copy_options} | |||
| is a bitmask type\iref{bitmask.types} that specifies bitmask constants used to control the semantics of | |||
| copy operations. The constants are specified in option groups with the meanings listed in Table~\ref{tab:fs.enum.copy_options}. | |||
| copy operations. The constants are specified in option groups with the meanings listed in Table~\tref{fs.enum.copy_options}. | |||
|
General notes:
|
|
Oh, I see that #1263 discusses the (lack of) cross references, so everything may already be as intended. |
|
I fixed the duplicate "Table"s and pushed the results. |
Partially addresses #1263.
I haven't squashed the commits; I can do so if desired.