Skip to content

Commit efdda2b

Browse files
jensmaurertkoeppe
authored andcommitted
[lib] Harmonize punctuation of 'Effects: Equivalent to' (#1815)
1 parent 63ccd05 commit efdda2b

File tree

5 files changed

+20
-58
lines changed

5 files changed

+20
-58
lines changed

source/atomics.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -747,7 +747,7 @@
747747

748748
\begin{itemdescr}
749749
\pnum
750-
\effects Equivalent to: \tcode{store(desired)}.
750+
\effects Equivalent to \tcode{store(desired)}.
751751

752752
\pnum
753753
\returns \tcode{desired}.

source/iostreams.tex

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11821,7 +11821,7 @@
1182111821

1182211822
\begin{itemdescr}
1182311823
\pnum
11824-
\effects Equivalent to \tcode{return *this += path(first, last)}.
11824+
\effects Equivalent to: \tcode{return *this += path(first, last);}
1182511825
\end{itemdescr}
1182611826

1182711827
\rSec4[fs.path.modifiers]{\tcode{path} modifiers}
@@ -11982,7 +11982,7 @@
1198211982

1198311983
\begin{itemdescr}
1198411984
\pnum
11985-
\returns Equivalent to \tcode{native().c_str()}.
11985+
\effects Equivalent to: \tcode{return native().c_str();}
1198611986
\end{itemdescr}
1198711987

1198811988
\indexlibrarymember{operator string_type}{path}%
@@ -12590,7 +12590,7 @@
1259012590

1259112591
\begin{itemdescr}
1259212592
\pnum
12593-
\effects Equivalent to: \tcode{lhs.swap(rhs);}
12593+
\effects Equivalent to \tcode{lhs.swap(rhs)}.
1259412594
\end{itemdescr}
1259512595

1259612596
\indexlibrary{\idxcode{hash_value}!\idxcode{path}}%

source/regex.tex

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1659,10 +1659,7 @@
16591659

16601660
\begin{itemdescr}
16611661
\pnum
1662-
\effects Equivalent to \tcode{*this = that}.
1663-
1664-
\pnum
1665-
\returns \tcode{*this}.
1662+
\effects Equivalent to: \tcode{return *this = that;}
16661663
\end{itemdescr}
16671664

16681665
\indexlibrarymember{basic_regex}{assign}%
@@ -1672,10 +1669,7 @@
16721669

16731670
\begin{itemdescr}
16741671
\pnum
1675-
\effects Equivalent to \tcode{*this = std::move(that)}.
1676-
1677-
\pnum
1678-
\returns \tcode{*this}.
1672+
\effects Equivalent to: \tcode{return *this = std::move(that);}
16791673
\end{itemdescr}
16801674

16811675
\indexlibrarymember{basic_regex}{assign}%

source/strings.tex

Lines changed: 10 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -2110,11 +2110,7 @@
21102110

21112111
\begin{itemdescr}
21122112
\pnum
2113-
\effects Equivalent to \tcode{append(basic_string(n, c))}.
2114-
2115-
\pnum
2116-
\returns
2117-
\tcode{*this}.
2113+
\effects Equivalent to: \tcode{return append(basic_string(n, c));}
21182114
\end{itemdescr}
21192115

21202116
\indexlibrarymember{append}{basic_string}%
@@ -2128,11 +2124,7 @@
21282124
\requires \range{first}{last} is a valid range.
21292125

21302126
\pnum
2131-
\effects Equivalent to \tcode{append(basic_string(first, last, get_allocator()))}.
2132-
2133-
\pnum
2134-
\returns
2135-
\tcode{*this}.
2127+
\effects Equivalent to: \tcode{return append(basic_string(first, last, get_allocator()));}
21362128
\end{itemdescr}
21372129

21382130
\indexlibrarymember{append}{basic_string}%
@@ -2170,11 +2162,7 @@
21702162

21712163
\begin{itemdescr}
21722164
\pnum
2173-
\effects Equivalent to \tcode{*this = str}.
2174-
2175-
\pnum
2176-
\returns
2177-
\tcode{*this}.
2165+
\effects Equivalent to: \tcode{return *this = str;}
21782166
\end{itemdescr}
21792167

21802168
\indexlibrarymember{assign}{basic_string}%
@@ -2186,11 +2174,7 @@
21862174

21872175
\begin{itemdescr}
21882176
\pnum
2189-
\effects Equivalent to \tcode{*this = std::move(str)}.
2190-
2191-
\pnum
2192-
\returns
2193-
\tcode{*this}.
2177+
\effects Equivalent to: \tcode{return *this = std::move(str);}
21942178
\end{itemdescr}
21952179

21962180

@@ -2321,11 +2305,7 @@
23212305

23222306
\begin{itemdescr}
23232307
\pnum
2324-
\effects Equivalent to \tcode{assign(basic_string(n, c))}.
2325-
2326-
\pnum
2327-
\returns
2328-
\tcode{*this}.
2308+
\effects Equivalent to: \tcode{return assign(basic_string(n, c));}
23292309
\end{itemdescr}
23302310

23312311
\indexlibrarymember{assign}{basic_string}%
@@ -2336,11 +2316,7 @@
23362316

23372317
\begin{itemdescr}
23382318
\pnum
2339-
\effects Equivalent to \tcode{assign(basic_string(first, last, get_allocator()))}.
2340-
2341-
\pnum
2342-
\returns
2343-
\tcode{*this}.
2319+
\effects Equivalent to: \tcode{return assign(basic_string(first, last, get_allocator()));}
23442320
\end{itemdescr}
23452321

23462322
\rSec4[string.insert]{\tcode{basic_string::insert}}
@@ -2472,11 +2448,7 @@
24722448

24732449
\begin{itemdescr}
24742450
\pnum
2475-
\effects Equivalent to \tcode{insert(pos, basic_string(n, c))}.
2476-
2477-
\pnum
2478-
\returns
2479-
\tcode{*this}.
2451+
\effects Equivalent to: \tcode{return insert(pos, basic_string(n, c));}
24802452
\end{itemdescr}
24812453

24822454
\indexlibrarymember{insert}{basic_string}%
@@ -2800,11 +2772,7 @@
28002772

28012773
\begin{itemdescr}
28022774
\pnum
2803-
\effects Equivalent to \tcode{replace(pos1, n1, basic_string(n2, c))}.
2804-
2805-
\pnum
2806-
\returns
2807-
\tcode{*this}.
2775+
\effects Equivalent to: \tcode{return replace(pos1, n1, basic_string(n2, c));}
28082776
\end{itemdescr}
28092777

28102778
\indexlibrarymember{replace}{basic_string}%
@@ -2958,7 +2926,7 @@
29582926

29592927
\pnum
29602928
\effects
2961-
Equivalent to: \tcode{traits::copy(s, data() + pos, rlen)}.
2929+
Equivalent to \tcode{traits::copy(s, data() + pos, rlen)}.
29622930
\begin{note} This does not terminate \tcode{s} with a null object. \end{note}
29632931

29642932
\pnum
@@ -4176,7 +4144,7 @@
41764144
\begin{itemdescr}
41774145
\pnum
41784146
\effects
4179-
Equivalent to: \tcode{lhs.swap(rhs);}
4147+
Equivalent to \tcode{lhs.swap(rhs)}.
41804148
\end{itemdescr}
41814149

41824150
\rSec3[string.io]{Inserters and extractors}

source/utilities.tex

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11216,7 +11216,7 @@
1121611216
\begin{itemdescr}
1121711217
\pnum
1121811218
\effects
11219-
Equivalent to: \tcode{do_deallocate(p, bytes, alignment);}
11219+
Equivalent to \tcode{do_deallocate(p, bytes, alignment)}.
1122011220
\end{itemdescr}
1122111221

1122211222
\indexlibrarymember{is_equal}{memory_resource}%
@@ -11437,8 +11437,8 @@
1143711437

1143811438
\begin{itemdescr}
1143911439
\pnum
11440-
\returns
11441-
Equivalent to
11440+
\effects
11441+
Equivalent to:
1144211442
\begin{codeblock}
1144311443
return static_cast<Tp*>(memory_rsrc->allocate(n * sizeof(Tp), alignof(Tp)));
1144411444
\end{codeblock}
@@ -14163,7 +14163,7 @@
1416314163
\begin{itemdescr}
1416414164
\pnum
1416514165
\effects
14166-
Equivalent to \tcode{return \placeholder{call_wrapper}(std::forward<F>(f));}
14166+
Equivalent to: \tcode{return \placeholder{call_wrapper}(std::forward<F>(f));}
1416714167
where \tcode{\placeholder{call_wrapper}} is an exposition only class defined as follows:
1416814168
\begin{codeblock}
1416914169
class @\placeholder{call_wrapper}@ {

0 commit comments

Comments
 (0)