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

Fix Pin urls in Option documentation #62491

Merged
merged 1 commit into from
Jul 16, 2019
Merged

Fix Pin urls in Option documentation #62491

merged 1 commit into from
Jul 16, 2019

Conversation

GuillaumeGomez
Copy link
Member

Fixes the following situation:

Screenshot from 2019-07-08 13-24-59

r? @QuietMisdreavus

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 8, 2019
@tesuji
Copy link
Contributor

tesuji commented Jul 8, 2019 •
edited
Loading

I think we already had links to Pin in method definitions. So make additional links in docs
seems redundant to me.

@GuillaumeGomez
Copy link
Member Author

@lzutao That's not even about duplicates or whatever: if a type appears in the documentation and it's not Self, then it has to be linked to its location.

@czipperz
Copy link
Contributor

It seems like some fundamental types auto link (ie i32) from my experience.

@GuillaumeGomez
Copy link
Member Author

They should but reality is often harsh and deceptive. 🤣

@QuietMisdreavus
Copy link
Member

The fact that those were able to get merged and make it into nightly makes me wonder about the "missing intra-doc link target" lint. Is that being properly warned against in libcore? I would expect that to generate a warning.

@lzutao It looks like these methods didn't have any links in the doc text, and the fact that the types are also hyperlinked is not obvious from looking at it. Having the links in these docs is fine.

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Jul 13, 2019

📌 Commit 224757f has been approved by QuietMisdreavus

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 13, 2019
Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this pull request Jul 13, 2019
@Mark-Simulacrum
Rollup merge of rust-lang#62491 - GuillaumeGomez:fix-pin-urls-for-opt…
6b6858d 
…ion, r=QuietMisdreavus

Fix Pin urls in Option documentation

Fixes the following situation:

![Screenshot from 2019-07-08 13-24-59](https://user-images.githubusercontent.com/3050060/60806822-55dfdc00-a184-11e9-9ee3-279e82fc92bd.png)

r? @QuietMisdreavus
@Mark-Simulacrum Mark-Simulacrum mentioned this pull request Jul 13, 2019
Closed
Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this pull request Jul 15, 2019
@Mark-Simulacrum
Rollup merge of rust-lang#62491 - GuillaumeGomez:fix-pin-urls-for-opt…
d6f0c0c 
…ion, r=QuietMisdreavus

Fix Pin urls in Option documentation

Fixes the following situation:

![Screenshot from 2019-07-08 13-24-59](https://user-images.githubusercontent.com/3050060/60806822-55dfdc00-a184-11e9-9ee3-279e82fc92bd.png)

r? @QuietMisdreavus
@Mark-Simulacrum Mark-Simulacrum mentioned this pull request Jul 15, 2019
Merged
bors added a commit that referenced this pull request Jul 16, 2019
@bors
Auto merge of #62704 - Mark-Simulacrum:rollup-oi94s2j, r=Mark-Simulacrum
02785da 
Rollup of 14 pull requests

Successful merges:

 - #62103 (Add debug assertions to write_bytes and copy*)
 - #62405 (Remove never_type feature requirement for exhaustive patterns)
 - #62491 (Fix Pin urls in Option documentation)
 - #62533 (Add missing links for CannotReallocInPlace type)
 - #62634 (Less unsafe in the array example of MaybeUninit docs)
 - #62639 (Make VaListImpl<'f> invariant over the 'f lifetime)
 - #62646 (Tweak wording in feature gate errors)
 - #62662 (add spaces in front of trait requirements in libcore/cell.rs)
 - #62668 (Fix #62660)
 - #62673 (miri validation: better error messages for dangling references)
 - #62680 (Actually call `visit_block_entry` in `DataflowResultsConsumer`)
 - #62685 (Add info about undefined behavior to as_ref suggestions)
 - #62689 (Fix typo in RawWaker::new documentation)
 - #62698 (SGX target: don't pretend to be GNU/Linux to LLVM)

Failed merges:

r? @ghost
@bors bors merged commit 224757f into rust-lang:master Jul 16, 2019
@GuillaumeGomez GuillaumeGomez deleted the fix-pin-urls-for-option branch July 16, 2019 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@QuietMisdreavus QuietMisdreavus QuietMisdreavus approved these changes

Assignees

@QuietMisdreavus QuietMisdreavus

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@GuillaumeGomez @tesuji @czipperz @QuietMisdreavus @bors @rust-highfive