Skip to content

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

@Ms2ger

Description

@Ms2ger
Contributor

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

Activity

steveklabnik

steveklabnik commented on Apr 12, 2016

@steveklabnik
Member

part of #29377

added
E-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.
on Jun 27, 2016
steveklabnik

steveklabnik commented on Jun 27, 2016

@steveklabnik
Member

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

added
E-help-wantedCall for participation: Help is requested to fix this issue.
on Jun 27, 2016
izgzhen

izgzhen commented on Jul 8, 2016

@izgzhen
Contributor

@steveklabnik Can I work on this one?

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

Ms2ger

Ms2ger commented on Jul 8, 2016

@Ms2ger
ContributorAuthor

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

steveklabnik commented on Jul 8, 2016

@steveklabnik
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.

JustAPerson

JustAPerson commented on Aug 16, 2016

@JustAPerson
Contributor

Looks like this can be closed?

steveklabnik

steveklabnik commented on Aug 17, 2016

@steveklabnik
Member

Yes, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    E-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.E-help-wantedCall for participation: Help is requested to fix this issue.E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @steveklabnik@Ms2ger@JustAPerson@izgzhen

        Issue actions

          Consider moving some docs from alloc::arc to alloc::arc::Arc · Issue #32905 · rust-lang/rust