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

[stringbuf.virtuals] has "Returns:" inside Effects: #1552

Closed
jwakely opened this issue Mar 18, 2017 · 3 comments
Closed

[stringbuf.virtuals] has "Returns:" inside Effects: #1552

jwakely opened this issue Mar 18, 2017 · 3 comments

Comments

@jwakely
Copy link
Member

jwakely commented Mar 18, 2017

We could change the Effects: to say something like "The result is c" and then change the Returns: to:

Returns: The result as described above, or traits::eof() to indicate failure.
@jwakely
Copy link
Member Author

jwakely commented Mar 18, 2017

Or follow the style of the overflow function right below it, so the Effects: say "Signals success by returning c."

@jwakely
Copy link
Member Author

jwakely commented Mar 18, 2017 •
edited

Same issue in [filebuf.virtuals] and [depr.strstreambuf.virtuals].

@jwakely jwakely mentioned this issue Mar 18, 2017
Open
@jwakely
Copy link
Member Author

jwakely commented Jul 20, 2017 •
edited

I've just re-noticed the same thing in [filebuf.virtuals], I'll fix it the same way.

jwakely added a commit that referenced this issue Jul 20, 2017
@jwakely
[filebuf.virtuals] Refer to return values specified in Effects
119b98d 
Fixes #1552
Eelis pushed a commit to Eelis/draft that referenced this issue Jul 24, 2017
@jwakely @Eelis
[filebuf.virtuals] Refer to return values specified in Effects
1f2d564 
Fixes cplusplus#1552
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
1 participant
@jwakely