[library] Add full stops to \returns etc. #1238
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I've updated the style guidelines to fix the "Returns: T{0}" bug. |
|
Looks like an improvement to me. The commit comment for the first one might want to mention that capitalization (first letter after element designation) is also adjusted. |
jlaire
force-pushed
the
library-elements-punct
branch
2 times, most recently
from
c7d96a1
to
a42eb80
Compare
Capitalize the first word and end in a full stop.
jlaire
force-pushed
the
library-elements-punct
branch
from
a42eb80
to
f6a52cd
Compare
|
I reworded the commit message and added a few more fixes. |
tkoeppe
reviewed
Dec 14, 2016
| @@ -18990,7 +18990,7 @@ | |||
| \begin{example} | |||
| \begin{codeblock} | |||
| using namespace std; | |||
| vector<int> v = ... | |||
| vector<int> v = ...; | |||
There was a problem hiding this comment.
This isn't valid syntax. Could you perhaps use vector<int> v = @\commentellip@;?
There was a problem hiding this comment.
Thanks, I didn't know about that. There seem to be many uses of literal ... that could be changed, but I'll leave the others for a different PR.
tkoeppe
reviewed
Dec 14, 2016
| @@ -1281,15 +1281,15 @@ | |||
| tuple_element<0, pair<T1, T2>>::type | |||
| \end{itemdecl} | |||
| \begin{itemdescr} | |||
| \pnum\textit{Value:} the type \tcode{T1}. | |||
| \pnum\textit{Value:} The type \tcode{T1}. | |||
There was a problem hiding this comment.
The value is a type? Eww. This is weird.
jlaire
force-pushed
the
library-elements-punct
branch
from
f6a52cd
to
2957ebe
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
My understanding is that we want to always end \returns and other elements in a full stop. The wiki (https://github.com/cplusplus/draft/wiki/Specification-Style-Guidelines) seems to agree with this, although it doesn't talk about all elements and there is one conflicting "Returns:
T{0}" example.I haven't gone through the whole draft so there are likely a lot more remaining. These are just ones I've noticed so far.