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

Incorrect hyperlink in API doc comment? #42373

Closed
frewsxcv opened this issue Jun 2, 2017 · 3 comments
Closed

Incorrect hyperlink in API doc comment? #42373

frewsxcv opened this issue Jun 2, 2017 · 3 comments
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. P-low Low priority

Comments

@frewsxcv
Copy link
Member

frewsxcv commented Jun 2, 2017 •
edited
Loading

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).
@frewsxcv frewsxcv added P-low Low priority A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Jun 2, 2017
@GuillaumeGomez
Copy link
Member

GuillaumeGomez commented Jun 2, 2017 •
edited
Loading

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
Copy link
Member

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
Copy link
Member

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

@Mark-Simulacrum Mark-Simulacrum added the C-enhancement Category: An issue proposing an enhancement or a PR with one. label Jul 27, 2017
frewsxcv added a commit to frewsxcv/rust that referenced this issue Sep 16, 2017
@frewsxcv
Fix incorrect into_inner link in docs.
5ff7064 
Fixes rust-lang#42373.
@frewsxcv frewsxcv mentioned this issue Sep 16, 2017
Merged
frewsxcv added a commit to frewsxcv/rust that referenced this issue Sep 16, 2017
@frewsxcv
Rollup merge of rust-lang#44622 - frewsxcv:frewsxcv-invalid-link, r=Q…
78ef3fe 
…uietMisdreavus

Fix incorrect `into_inner` link in docs.

Fixes rust-lang#42373.
TimNN added a commit to TimNN/rust that referenced this issue Sep 17, 2017
@TimNN
Rollup merge of rust-lang#44622 - frewsxcv:frewsxcv-invalid-link, r=Q…
f151622 
…uietMisdreavus

Fix incorrect `into_inner` link in docs.

Fixes rust-lang#42373.
TimNN added a commit to TimNN/rust that referenced this issue Sep 17, 2017
@TimNN
Rollup merge of rust-lang#44622 - frewsxcv:frewsxcv-invalid-link, r=Q…
cd63d16 
…uietMisdreavus

Fix incorrect `into_inner` link in docs.

Fixes rust-lang#42373.
TimNN added a commit to TimNN/rust that referenced this issue Sep 17, 2017
@TimNN
Rollup merge of rust-lang#44622 - frewsxcv:frewsxcv-invalid-link, r=Q…
bbb8986 
…uietMisdreavus

Fix incorrect `into_inner` link in docs.

Fixes rust-lang#42373.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. P-low Low priority
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@steveklabnik @frewsxcv @GuillaumeGomez @Mark-Simulacrum