Skip to content

Capitalize after "Effects:"/"Returns:"/"Throws:"/"Requires:". #1676

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 30, 2017
Merged

Capitalize after "Effects:"/"Returns:"/"Throws:"/"Requires:". #1676

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/iostreams.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11682,7 +11682,7 @@

\begin{itemdescr}
\pnum
\returns a path whose pathname in the generic format is
\returns A path whose pathname in the generic format is
the suffix of \tcode{filename()} not included in \tcode{stem()}.

\pnum
Expand Down
10 changes: 5 additions & 5 deletions source/regex.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1137,7 +1137,7 @@
\end{itemdecl}

\begin{itemdescr}
\pnum\returns a sequence of one or more characters that
\pnum\returns A sequence of one or more characters that
represents the collating element consisting of the character
sequence designated by the iterator range \range{first}{last}.
Returns an empty string if the character sequence is not a
Expand All @@ -1152,7 +1152,7 @@
\end{itemdecl}

\begin{itemdescr}
\pnum\returns an unspecified value that represents
\pnum\returns An unspecified value that represents
the character classification named by the character sequence
designated by the iterator range \range{first}{last}.
If the parameter \tcode{icase} is \tcode{true} then the returned mask identifies the
Expand Down Expand Up @@ -1240,7 +1240,7 @@
\requires The value of \tcode{radix} shall be 8, 10, or 16.

\pnum
\returns the value represented by the digit \tcode{ch} in base
\returns The value represented by the digit \tcode{ch} in base
\tcode{radix} if the character \tcode{ch} is a valid digit in base
\tcode{radix}; otherwise returns \tcode{-1}.
\end{itemdescr}
Expand All @@ -1259,7 +1259,7 @@
data held by \tcode{*this}. \end{note}

\pnum
\returns if no locale has been previously imbued then a copy of the
\returns If no locale has been previously imbued then a copy of the
global locale in effect at the time of construction of \tcode{*this},
otherwise a copy of the last argument passed to \tcode{imbue}.

Expand All @@ -1275,7 +1275,7 @@

\begin{itemdescr}
\pnum
\returns if no locale has been imbued then a copy of the global locale
\returns If no locale has been imbued then a copy of the global locale
in effect at the time of construction of \tcode{*this}, otherwise a copy of
the last argument passed to \tcode{imbue}.
\end{itemdescr}
Expand Down
4 changes: 2 additions & 2 deletions source/strings.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4391,7 +4391,7 @@

\begin{itemdescr}
\pnum
\effects the first two functions call \tcode{strtol(str.c_str(), ptr, base)},
\effects The first two functions call \tcode{strtol(str.c_str(), ptr, base)},
and the last three functions call \tcode{strtoul(str.c_str(), ptr, base)},
\tcode{strtoll(str.c_str(), ptr, base)}, and \tcode{strtoull(\brk{}str.c_str(), ptr,
base)}, respectively. Each function returns the converted result, if any. The
Expand Down Expand Up @@ -4488,7 +4488,7 @@

\begin{itemdescr}
\pnum
\effects the first two functions call \tcode{wcstol(str.c_str(), ptr, base)},
\effects The first two functions call \tcode{wcstol(str.c_str(), ptr, base)},
and the last three functions call \tcode{wcstoul(str.c_str(), ptr, base)},
\tcode{wcstoll(str.c_str(), ptr, base)}, and \tcode{wcstoull(\brk{}str.c_str(), ptr,
base)}, respectively. Each function returns the converted result, if any. The
Expand Down
2 changes: 1 addition & 1 deletion source/support.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2592,7 +2592,7 @@

\begin{itemdescr}
\pnum
\effects constructs an object of class \tcode{bad_array_new_length}.
\effects Constructs an object of class \tcode{bad_array_new_length}.
\end{itemdescr}

\indexlibrarymember{what}{bad_array_new_length}%
Expand Down
12 changes: 6 additions & 6 deletions source/threads.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3972,7 +3972,7 @@

\begin{itemdescr}
\pnum
\effects constructs a \tcode{promise} object and a shared state. The second
\effects Constructs a \tcode{promise} object and a shared state. The second
constructor uses the allocator \tcode{a} to allocate memory for the shared
state.
\end{itemdescr}
Expand All @@ -3984,7 +3984,7 @@

\begin{itemdescr}
\pnum
\effects constructs a new \tcode{promise} object and transfers ownership of the shared state
\effects Constructs a new \tcode{promise} object and transfers ownership of the shared state
of \tcode{rhs} (if any) to the newly-constructed object.

\pnum
Expand Down Expand Up @@ -4382,7 +4382,7 @@
\end{itemize}

\pnum
\throws the stored exception, if an exception was stored in the shared state.
\throws The stored exception, if an exception was stored in the shared state.

\pnum
\postconditions \tcode{valid() == false}.
Expand Down Expand Up @@ -4698,7 +4698,7 @@
\end{itemize}

\pnum
\throws the stored exception, if an exception was stored in the shared state.
\throws The stored exception, if an exception was stored in the shared state.
\end{itemdescr}

\indexlibrarymember{valid}{shared_future}%
Expand Down Expand Up @@ -5142,7 +5142,7 @@
\returns A \tcode{future} object that shares the same shared state as \tcode{*this}.

\pnum
\throws a \tcode{future_error} object if an error occurs.
\throws A \tcode{future_error} object if an error occurs.

\pnum
\errors
Expand Down Expand Up @@ -5171,7 +5171,7 @@
the shared state of \tcode{*this} to become ready are unblocked.

\pnum
\throws a \tcode{future_error} exception object if there is no shared
\throws A \tcode{future_error} exception object if there is no shared
state or the stored task has already been invoked.

\pnum
Expand Down
12 changes: 6 additions & 6 deletions source/utilities.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8506,7 +8506,7 @@
\begin{itemdescr}
\pnum
\effects
constructs a \tcode{default_delete} object from another \tcode{default_delete<U[]>} object.
Constructs a \tcode{default_delete} object from another \tcode{default_delete<U[]>} object.

\pnum
\remarks
Expand Down Expand Up @@ -12703,7 +12703,7 @@

\begin{itemdescr}
\pnum
\requires all of the types in \tcode{Args1} and \tcode{Args2} shall be
\requires All of the types in \tcode{Args1} and \tcode{Args2} shall be
\tcode{CopyConstructible} (Table~\ref{tab:copyconstructible}).

\pnum
Expand Down Expand Up @@ -14596,7 +14596,7 @@
\tcode{*this} targets a copy of \tcode{f.target()}.

\pnum
\throws shall not throw exceptions if \tcode{f}'s target is
\throws Shall not throw exceptions if \tcode{f}'s target is
a specialization of \tcode{reference_wrapper} or
a function pointer. Otherwise, may throw \tcode{bad_alloc}
or any exception thrown by the copy constructor of the stored callable object.
Expand All @@ -14619,7 +14619,7 @@
\tcode{f} is in a valid state with an unspecified value.

\pnum
\throws shall not throw exceptions if \tcode{f}'s target is
\throws Shall not throw exceptions if \tcode{f}'s target is
a specialization of \tcode{reference_wrapper} or
a function pointer. Otherwise, may throw \tcode{bad_alloc} or
any exception thrown by the copy or move constructor
Expand Down Expand Up @@ -14662,7 +14662,7 @@
reference to an object and a member function pointer. \end{note}

\pnum
\throws shall not throw exceptions when \tcode{f} is a function pointer
\throws Shall not throw exceptions when \tcode{f} is a function pointer
or a \tcode{reference_wrapper<T>} for some \tcode{T}. Otherwise,
may throw \tcode{bad_alloc} or any exception thrown by \tcode{F}'s copy
or move constructor.
Expand Down Expand Up @@ -14777,7 +14777,7 @@
\end{itemdecl}

\begin{itemdescr}
\pnum\effects interchanges the targets of \tcode{*this} and \tcode{other}.
\pnum\effects Interchanges the targets of \tcode{*this} and \tcode{other}.
\end{itemdescr}

\rSec4[func.wrap.func.cap]{\tcode{function} capacity}
Expand Down