Skip to content

Incorrect hyperlink in API doc comment? #42373

Description

@frewsxcv

someone in IRC mentioned this should actually point to PoisonError::into_inner. i would fix it myself, i don't really understand what the sentence means that uses that link (but i'm also pretty tired).

Activity

added
P-lowLow priority
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and tools
on Jun 2, 2017

GuillaumeGomez commented on Jun 2, 2017

@GuillaumeGomez
Member

It doesn't seem logical to me: this is returned from a Mutex method, so it's normal that we're talking about the Mutex::into_inner method, no?

steveklabnik commented on Jun 5, 2017

@steveklabnik
Contributor

So, https://doc.rust-lang.org/stable/std/sync/struct.Mutex.html#method.into_inner is how you get a LockResult, but that sentence is trying to point to PoisonError.

GuillaumeGomez commented on Jun 6, 2017

@GuillaumeGomez
Member

Then we just rephrase it in order to make it sound more logical. :)

added 2 commits that reference this issue on Sep 16, 2017
added 3 commits that reference this issue on Sep 17, 2017
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

    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-enhancementCategory: An issue proposing an enhancement or a PR with one.P-lowLow priority

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions