Skip to content
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

Jump to bottom

"Returns:" should be followed by an English sentence #223

Closed
lichray opened this issue Oct 23, 2013 · 2 comments
Closed

"Returns:" should be followed by an English sentence #223

lichray opened this issue Oct 23, 2013 · 2 comments

Comments

@lichray
Copy link
Contributor

lichray commented Oct 23, 2013

There are several different practices in the standard:

  1. Returns: expr
  2. Returns: expr.
  3. Returns: expr;
  4. Returns: expr;.
  5. Returns: English sentence.
  6. Returns: expr; english sentence.

Suggestion:

Regard an expression as an English sentence, thus, keep 2 and 5, replace 1,3,4 with 2, replace 6 with "Returns: expr, english sentence.".
@tkoeppe
Copy link
Contributor

tkoeppe commented Dec 8, 2016

I'm pretty sure this is a duplicate. @jensmaurer: Do you recall us discussing this not too long ago?

@jwakely
Copy link
Member

jwakely commented Dec 8, 2016

See #694 and #1119

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@lichray @jwakely @tkoeppe @jensmaurer