Skip to content

improve documentation for std::pin::Pin #104107

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom
Closed
vincenzopalazzo opened this issue Nov 7, 2022 · 4 comments
Closed

improve documentation for std::pin::Pin #104107

vincenzopalazzo opened this issue Nov 7, 2022 · 4 comments
Assignees
@ch-iv
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.

Comments

@vincenzopalazzo
Copy link
Member

vincenzopalazzo commented Nov 7, 2022 •
edited by rustbot
Loading

Summary

As @yoshuawuyts pointed out on Zulip stream the in struct, there is a lack of documentation on some of the methods such as Pin::new() and Pin::into_inner

This should be relatively straight forward to document, and I can mentor someone if there is interest
@vincenzopalazzo vincenzopalazzo added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Nov 7, 2022
@vincenzopalazzo
Copy link
Member Author

vincenzopalazzo commented Nov 7, 2022 •
edited
Loading

@rustbot label +E-mentor

@rustbot rustbot added the E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. label Nov 7, 2022
@ch-iv
Copy link
Contributor

ch-iv commented Nov 7, 2022

I can try doing this

@ch-iv
Copy link
Contributor

ch-iv commented Nov 7, 2022

@rustbot claim

@ch-iv ch-iv mentioned this issue Nov 9, 2022
Closed
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Dec 6, 2022
@matthiaskrgr
Rollup merge of rust-lang#104195 - ch-iv:documentation-104107, r=eholk
7b2f2a8 
Add examples for std::pin::Pin new() and into_inner() methods

Fixes rust-lang#104107
@vincenzopalazzo
Copy link
Member Author

Fixed in #105902

# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees

@ch-iv ch-iv

Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools 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.

Add examples for std::pin::Pin new() and into_inner() methods
3 participants
@vincenzopalazzo @rustbot @ch-iv