Skip to content

Consider moving some docs from alloc::arc to alloc::arc::Arc #32905

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
Ms2ger opened this issue Apr 12, 2016 · 7 comments
Closed

Consider moving some docs from alloc::arc to alloc::arc::Arc #32905

Ms2ger opened this issue Apr 12, 2016 · 7 comments
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

@Ms2ger
Copy link
Contributor

Ms2ger commented Apr 12, 2016

http://static.rust-lang.org/doc/master/alloc/arc/index.html has some useful docs, which are somewhat hard to find. In particular, someone on IRC misconstrued the more terse documentation on the Arc type itself to mean that it magically allowed mutable access.

CC @steveklabnik
@steveklabnik
Copy link
Member

part of #29377

@steveklabnik steveklabnik added 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. labels Jun 27, 2016
@steveklabnik
Copy link
Member

I would be happy to work with anyone who wants to work on this issue.

@steveklabnik steveklabnik added the E-help-wanted Call for participation: Help is requested to fix this issue. label Jun 27, 2016
@izgzhen
Copy link
Contributor

izgzhen commented Jul 8, 2016

@steveklabnik Can I work on this one?

@Ms2ger Do you mean the lack of more information regarding get_mut and make_mut?

@Ms2ger
Copy link
Contributor Author

Ms2ger commented Jul 8, 2016

I think everything on the module page would be more discoverable on the type page; the module page could then be limited to its first line and a link to the type page.

@steveklabnik
Copy link
Member

@izgzhen sure thing!

In general, the module page should provide an overview of the module. And each type's page should provide an in-depth view of the type.

This module is very tiny, only encompassing Arc and Weak, and so it should be relatively small.

@izgzhen izgzhen mentioned this issue Jul 9, 2016
Merged
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this issue Jul 15, 2016
@GuillaumeGomez
Rollup merge of rust-lang#34733 - izgzhen:alloc-arc-doc-improve, r=st…
257b351 
…eveklabnik

Improve arc doc, fixing rust-lang#32905

As issue rust-lang#32905 detailed, I moved part of the module doc to the struct doc, and fixed some small places in the `alloc::arc`.
@JustAPerson
Copy link
Contributor

Looks like this can be closed?

@steveklabnik
Copy link
Member

Yes, thanks!

# for free to join this conversation on GitHub. Already have an account? # 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

No branches or pull requests
4 participants
@steveklabnik @Ms2ger @JustAPerson @izgzhen