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

Documentation is not entirely clear what write! returns #35110

Closed
nagisa opened this issue Jul 29, 2016 · 9 comments · Fixed by #35279
Closed

Documentation is not entirely clear what write! returns #35110

nagisa opened this issue Jul 29, 2016 · 9 comments · Fixed by #35279
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-help-wanted Call for participation: Help is requested to fix this issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.

Comments

@nagisa
Copy link
Member

nagisa commented Jul 29, 2016

Looking at write! documentation page, the only thing you can figure out is that write! does return something and “something” has a unwrap() method.
@TimNN
Copy link
Contributor

TimNN commented Jul 29, 2016

I'm pretty sure that write is not even guaranteed to return anything with an unwrap() method...

Write basically calls whatever write_fmt method on $dst is in scope (and makes no other guarantees).

@nagisa
Copy link
Member Author

nagisa commented Jul 29, 2016

It, then, should document that.

@retep998
Copy link
Member

Yay duck typing!

@steveklabnik
Copy link
Member

part of #29381

@steveklabnik steveklabnik added A-docs E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. E-help-wanted Call for participation: Help is requested to fix this issue. labels Jul 29, 2016
@steveklabnik
Copy link
Member

I would be willing to work with anyone who wanted to fix this issue.

@TimNN
Copy link
Contributor

TimNN commented Jul 29, 2016

Some related issues regarding that macro & it's documentation: #21615, #28049

@cengiz-io
Copy link
Contributor

@steveklabnik Hello! I can work on this.

@steveklabnik
Copy link
Member

@cengizio great! Do you need any help from me?

@cengiz-io
Copy link
Contributor

@steveklabnik Hello. Not currently. I'll come up with a PR and ask your comments on it tomorrow or the next day.

Thanks for keeping an eye!

@cengiz-io cengiz-io mentioned this issue Aug 4, 2016
Merged
steveklabnik added a commit to steveklabnik/rust that referenced this issue Aug 10, 2016
@steveklabnik
Rollup merge of rust-lang#35279 - cengizIO:master, r=brson
96c39d2 
Provide a cleaner documentation for 'write!'

Hello!

This is my attempt to fix rust-lang#35110

Any feedback is more than welcome!

Cheers!
sophiajt pushed a commit to sophiajt/rust that referenced this issue Aug 10, 2016
Rollup merge of rust-lang#35279 - cengizIO:master, r=brson
56cc1fc 
Provide a cleaner documentation for 'write!'

Hello!

This is my attempt to fix rust-lang#35110

Any feedback is more than welcome!

Cheers!
sophiajt pushed a commit to sophiajt/rust that referenced this issue Aug 11, 2016
Rollup merge of rust-lang#35279 - cengizIO:master, r=brson
476e496 
Provide a cleaner documentation for 'write!'

Hello!

This is my attempt to fix rust-lang#35110

Any feedback is more than welcome!

Cheers!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-help-wanted Call for participation: Help is requested to fix this issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Provide a cleaner documentation for 'write!'
5 participants
@steveklabnik @cengiz-io @retep998 @nagisa @TimNN