Skip to content

Commit f66fb79

Browse files
Johannes Lairetkoeppe
authored andcommitted
[lib] Fix capitalization and punctuation in itemdescrs. (#1238)
1 parent d63754b commit f66fb79

File tree

6 files changed

+35
-35
lines changed

6 files changed

+35
-35
lines changed

source/containers.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3193,7 +3193,7 @@
31933193
\end{itemdecl}
31943194

31953195
\begin{itemdescr}
3196-
\pnum\returns \tcode{N}
3196+
\pnum\returns \tcode{N}.
31973197
\end{itemdescr}
31983198

31993199
\rSec3[array.data]{\tcode{array::data}}

source/iostreams.tex

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2031,7 +2031,7 @@
20312031
\begin{itemdescr}
20322032
\pnum
20332033
\postconditions
2034-
\tcode{traits::eq(fillch, fill())}
2034+
\tcode{traits::eq(fillch, fill())}.
20352035

20362036
\pnum
20372037
\returns
@@ -4317,7 +4317,7 @@
43174317

43184318
\pnum
43194319
\postconditions
4320-
\tcode{gcount() == 0}
4320+
\tcode{gcount() == 0}.
43214321
\end{itemdescr}
43224322

43234323

@@ -6720,7 +6720,7 @@
67206720
\effects As if by: \tcode{os \shl{} x;}
67216721

67226722
\pnum
6723-
\returns \tcode{os}
6723+
\returns \tcode{os}.
67246724

67256725
\pnum
67266726
\remarks This function shall not participate in overload resolution

source/regex.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1039,7 +1039,7 @@
10391039
\begin{itemdescr}
10401040
\pnum\effects Constructs an object of class \tcode{regex_error}.
10411041

1042-
\pnum\postconditions \tcode{ecode == code()}
1042+
\pnum\postconditions \tcode{ecode == code()}.
10431043
\end{itemdescr}
10441044

10451045
\indexlibrary{\idxcode{error_type}}%

source/support.tex

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2201,7 +2201,7 @@
22012201
\rSec3[new.delete.placement]{Non-allocating forms}
22022202

22032203
\pnum
2204-
These functions are reserved, a \Cpp program may not define functions that displace
2204+
These functions are reserved; a \Cpp program may not define functions that displace
22052205
the versions in the \Cpp standard library~(\ref{constraints}).
22062206
The provisions of~(\ref{basic.stc.dynamic}) do not apply to these reserved
22072207
placement forms of \tcode{operator new} and \tcode{operator delete}.
@@ -2451,7 +2451,7 @@
24512451
\indexlibrary{\idxcode{bad_alloc}}%
24522452
\tcode{bad_alloc};
24532453
\item
2454-
terminate execution of the program without returning to the caller;
2454+
terminate execution of the program without returning to the caller.
24552455
\indexlibrary{\idxcode{abort}}%
24562456
\indexlibrary{\idxcode{exit}}%
24572457
\end{itemize}
@@ -2717,7 +2717,7 @@
27172717
objects which compare equal.
27182718

27192719
\pnum
2720-
\remarks an implementation should return different values for two
2720+
\remarks An implementation should return different values for two
27212721
\tcode{type_info} objects which do not compare equal.
27222722
\end{itemdescr}
27232723

@@ -3258,7 +3258,7 @@
32583258
\requires \tcode{p} shall not be a null pointer.
32593259

32603260
\pnum
3261-
\throws the exception object to which \tcode{p} refers.
3261+
\throws The exception object to which \tcode{p} refers.
32623262
\end{itemdescr}
32633263

32643264
\indexlibrary{\idxcode{make_exception_ptr}}%
@@ -3359,7 +3359,7 @@
33593359

33603360
\pnum
33613361
\throws
3362-
if \tcode{is_class_v<U> \&\& !is_final_v<U> \&\& !is_base_of_v<nested_exception, U>}
3362+
If \tcode{is_class_v<U> \&\& !is_final_v<U> \&\& !is_base_of_v<nested_exception, U>}
33633363
is \tcode{true},
33643364
an exception of unspecified type that is publicly derived from both
33653365
\tcode{U} and \tcode{nested_exception}
@@ -3443,10 +3443,10 @@
34433443

34443444
\begin{itemdescr}
34453445
\pnum
3446-
\effects constructs an empty \tcode{initializer_list} object.
3446+
\effects Constructs an empty \tcode{initializer_list} object.
34473447

34483448
\pnum
3449-
\postconditions \tcode{size() == 0}
3449+
\postconditions \tcode{size() == 0}.
34503450
\end{itemdescr}
34513451

34523452
\rSec2[support.initlist.access]{Initializer list access}
@@ -3470,7 +3470,7 @@
34703470

34713471
\begin{itemdescr}
34723472
\pnum
3473-
\returns \tcode{begin() + size()}
3473+
\returns \tcode{begin() + size()}.
34743474
\end{itemdescr}
34753475

34763476
\indexlibrarymember{size}{initializer_list}%

source/threads.tex

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -449,7 +449,7 @@
449449

450450
\begin{itemdescr}
451451
\pnum
452-
\returns \tcode{!(y < x)}
452+
\returns \tcode{!(y < x)}.
453453
\end{itemdescr}
454454

455455
\indexlibrarymember{operator>}{thread::id}%
@@ -458,7 +458,7 @@
458458
\end{itemdecl}
459459

460460
\begin{itemdescr}
461-
\pnum\returns \tcode{y < x}
461+
\pnum\returns \tcode{y < x}.
462462
\end{itemdescr}
463463

464464
\indexlibrarymember{operator>=}{thread::id}%
@@ -467,7 +467,7 @@
467467
\end{itemdecl}
468468

469469
\begin{itemdescr}
470-
\pnum\returns \tcode{!(x < y)}
470+
\pnum\returns \tcode{!(x < y)}.
471471
\end{itemdescr}
472472

473473
\indexlibrarymember{operator\shl}{thread::id}%
@@ -484,7 +484,7 @@
484484
representation and if \tcode{x != y} the \tcode{thread::id} objects shall have
485485
distinct text representations.
486486

487-
\pnum\returns \tcode{out}
487+
\pnum\returns \tcode{out}.
488488
\end{itemdescr}
489489

490490
\indexlibrary{\idxcode{hash}!\idxcode{thread::id}}%
@@ -506,7 +506,7 @@
506506
\begin{itemdescr}
507507
\pnum\effects Constructs a \tcode{thread} object that does not represent a thread of execution.
508508

509-
\pnum\postconditions \tcode{get_id() == id()}
509+
\pnum\postconditions \tcode{get_id() == id()}.
510510
\end{itemdescr}
511511

512512
\indexlibrary{\idxcode{thread}!constructor}%
@@ -605,7 +605,7 @@
605605
\tcode{x.get_id()} prior to the assignment.
606606

607607
\pnum
608-
\returns \tcode{*this}
608+
\returns \tcode{*this}.
609609
\end{itemdescr}
610610

611611
\rSec3[thread.thread.member]{\tcode{thread} members}
@@ -627,7 +627,7 @@
627627

628628
\begin{itemdescr}
629629
\pnum
630-
\returns \tcode{get_id() != id()}
630+
\returns \tcode{get_id() != id()}.
631631
\end{itemdescr}
632632

633633
\indexlibrarymember{join}{thread}%
@@ -925,7 +925,7 @@
925925
\postconditions The calling thread owns the mutex.
926926

927927
\pnum
928-
\returntype \tcode{void}
928+
\returntype \tcode{void}.
929929

930930
\pnum
931931
\sync Prior \tcode{unlock()} operations on the same object shall
@@ -966,7 +966,7 @@
966966
in the absence of contending mutex acquisitions.
967967

968968
\pnum
969-
\returntype \tcode{bool}
969+
\returntype \tcode{bool}.
970970

971971
\pnum
972972
\returns \tcode{true} if ownership of the mutex was obtained for the calling
@@ -994,7 +994,7 @@
994994
\effects Releases the calling thread's ownership of the mutex.
995995

996996
\pnum
997-
\returntype \tcode{void}
997+
\returntype \tcode{void}.
998998

999999
\pnum
10001000
\sync This operation synchronizes with~(\ref{intro.multithread}) subsequent
@@ -1150,7 +1150,7 @@
11501150
\end{note}
11511151

11521152
\pnum
1153-
\returntype \tcode{bool}
1153+
\returntype \tcode{bool}.
11541154

11551155
\pnum
11561156
\returns \tcode{true} if ownership was obtained, otherwise \tcode{false}.
@@ -1182,7 +1182,7 @@
11821182
be obtained if the lock is available, but implementations are expected to make a
11831183
strong effort to do so. \end{note}
11841184

1185-
\pnum\returntype \tcode{bool}
1185+
\pnum\returntype \tcode{bool}.
11861186

11871187
\pnum
11881188
\returns \tcode{true} if ownership was obtained, otherwise \tcode{false}.
@@ -1966,7 +1966,7 @@
19661966
\effects As if by \tcode{pm->lock()}.
19671967

19681968
\pnum
1969-
\postconditions \tcode{owns == true}
1969+
\postconditions \tcode{owns == true}.
19701970

19711971
\pnum
19721972
\throws
@@ -2089,7 +2089,7 @@
20892089
\begin{itemdescr}
20902090
\pnum\effects As if by \tcode{pm->unlock()}.
20912091

2092-
\pnum\postconditions \tcode{owns == false}
2092+
\pnum\postconditions \tcode{owns == false}.
20932093

20942094
\pnum\throws \tcode{system_error} when
20952095
an exception is required~(\ref{thread.req.exception}).
@@ -2140,7 +2140,7 @@
21402140
\end{itemdecl}
21412141

21422142
\begin{itemdescr}
2143-
\pnum\returns \tcode{owns}
2143+
\pnum\returns \tcode{owns}.
21442144
\end{itemdescr}
21452145

21462146
\indexlibrarymember{operator bool}{unique_lock}%
@@ -2149,7 +2149,7 @@
21492149
\end{itemdecl}
21502150

21512151
\begin{itemdescr}
2152-
\pnum\returns \tcode{owns}
2152+
\pnum\returns \tcode{owns}.
21532153
\end{itemdescr}
21542154

21552155
\indexlibrarymember{mutex}{unique_lock}%
@@ -2158,7 +2158,7 @@
21582158
\end{itemdecl}
21592159

21602160
\begin{itemdescr}
2161-
\pnum\returns \tcode{pm}
2161+
\pnum\returns \tcode{pm}.
21622162
\end{itemdescr}
21632163

21642164
\rSec3[thread.lock.shared]{Class template \tcode{shared_lock}}

source/utilities.tex

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1281,15 +1281,15 @@
12811281
tuple_element<0, pair<T1, T2>>::type
12821282
\end{itemdecl}
12831283
\begin{itemdescr}
1284-
\pnum\textit{Value:} the type \tcode{T1}.
1284+
\pnum\textit{Value:} The type \tcode{T1}.
12851285
\end{itemdescr}
12861286

12871287
\indexlibrary{\idxcode{tuple_element}}%
12881288
\begin{itemdecl}
12891289
tuple_element<1, pair<T1, T2>>::type
12901290
\end{itemdecl}
12911291
\begin{itemdescr}
1292-
\pnum\textit{Value:} the type T2.
1292+
\pnum\textit{Value:} The type T2.
12931293
\end{itemdescr}
12941294

12951295
\indexlibrarymember{get}{pair}%
@@ -7344,7 +7344,7 @@
73447344

73457345
\begin{itemdescr}
73467346
\pnum
7347-
\remarks automatically detects whether \tcode{T} has a nested \tcode{allocator_type} that
7347+
\remarks Automatically detects whether \tcode{T} has a nested \tcode{allocator_type} that
73487348
is convertible from \tcode{Alloc}. Meets the BinaryTypeTrait
73497349
requirements~(\ref{meta.rqmts}). The implementation shall provide a definition that is
73507350
derived from \tcode{true_type} if the \grammarterm{qualified-id} \tcode{T::allocator_type}
@@ -9635,7 +9635,7 @@
96359635

96369636
\pnum
96379637
\postconditions \tcode{*this} shall contain the old value of
9638-
\tcode{r}. \tcode{r} shall be empty. \tcode{r.get() == nullptr.}
9638+
\tcode{r}. \tcode{r} shall be empty. \tcode{r.get() == nullptr}.
96399639
\end{itemdescr}
96409640

96419641
\indexlibrary{\idxcode{shared_ptr}!constructor}%
@@ -18990,7 +18990,7 @@
1899018990
\begin{example}
1899118991
\begin{codeblock}
1899218992
using namespace std;
18993-
vector<int> v = ...
18993+
vector<int> v = @\commentellip@;
1899418994

1899518995
// standard sequential sort
1899618996
sort(v.begin(), v.end());

0 commit comments

Comments
 (0)