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 doc links in std::cmp module #64142

Merged
merged 1 commit into from
Sep 5, 2019
Merged

Fix doc links in std::cmp module #64142

merged 1 commit into from
Sep 5, 2019

Conversation

tesuji
Copy link
Contributor

@tesuji tesuji commented Sep 4, 2019

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

tesuji commented Sep 4, 2019

For some reasons, the doc links which are fine in core::cmp but in std::cmp they are not rendered:
image

@tesuji tesuji changed the title Fix doc links in cmp module Fix doc links in std::cmp module Sep 4, 2019
@jonas-schievink
Copy link
Contributor

For some reasons, the doc links which are fine in core::cmp but in std::cmp they are not rendered:

That's probably due to #59833. Are both std and core links now working after this?

@tesuji
Copy link
Contributor Author

tesuji commented Sep 4, 2019

Yes, they are both working after this PR. I would prefer intra-links issue fixed, but I don't
have strong opinion about it.
I would let the decision to you or other reviewers.

@jonas-schievink
Copy link
Contributor

Okay, nice. Fixed links are always better than broken ones, so

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Sep 4, 2019

📌 Commit f5b71cc4e8a89e05b4479666550efbca4847bbba has been approved by jonas-schievink

@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 Sep 4, 2019
@tesuji
Copy link
Contributor Author

tesuji commented Sep 4, 2019 •
edited
Loading

Hm, Wait! I've just seen that there are 2 Eq identifiers in std::cmp:
image

Which one should I choose to document?
Edit: If I use macro ones, the links in core::cmp will be broken.

@rust-highfive
Copy link
Collaborator

Your PR failed (raw log). Through arcane magic we have determined that the following fragments from the build log may contain information about the problem.

Click to expand the log. 
2019-09-04T08:38:35.7079512Z ##[command]git remote add origin https://github.com/rust-lang/rust
2019-09-04T08:38:35.7269511Z ##[command]git config gc.auto 0
2019-09-04T08:38:35.7351988Z ##[command]git config --get-all http.https://github.com/rust-lang/rust.extraheader
2019-09-04T08:38:35.7407488Z ##[command]git config --get-all http.proxy
2019-09-04T08:38:35.7554243Z ##[command]git -c http.extraheader="AUTHORIZATION: basic ***" fetch --force --tags --prune --progress --no-recurse-submodules --depth=2 origin +refs/heads/*:refs/remotes/origin/* +refs/pull/64142/merge:refs/remotes/pull/64142/merge

I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact @TimNN. (Feature Requests)

@jonas-schievink
Copy link
Contributor

The traits should be the correct ones to document here

@tesuji
Copy link
Contributor Author

tesuji commented Sep 4, 2019

I changed them to point to trait items.

@jonas-schievink
Copy link
Contributor

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Sep 4, 2019

📌 Commit 470e5e0ee5b5f0dbf3f6261e8c655451c391b2d3 has been approved by jonas-schievink

ehuss
ehuss reviewed Sep 4, 2019
View reviewed changes
src/libcore/cmp.rs Outdated Show resolved Hide resolved
@tesuji
Fix doc links in std::cmp module
b6f9523 
These links are rendered in `core::cmp` but not in `std::cmp`.
@jonas-schievink
Copy link
Contributor

@bors r+

@bors
Copy link
Contributor

bors commented Sep 4, 2019

📌 Commit b6f9523 has been approved by jonas-schievink

Centril added a commit to Centril/rust that referenced this pull request Sep 5, 2019
@Centril
Rollup merge of rust-lang#64142 - lzutao:fix-doc-cmp, r=jonas-schievink
ee90e61 
Fix doc links in `std::cmp` module

r? @jonas-schievink
@Centril Centril mentioned this pull request Sep 5, 2019
Closed
Centril added a commit to Centril/rust that referenced this pull request Sep 5, 2019
@Centril
Rollup merge of rust-lang#64142 - lzutao:fix-doc-cmp, r=jonas-schievink
a0f0a96 
Fix doc links in `std::cmp` module

r? @jonas-schievink
@Centril Centril mentioned this pull request Sep 5, 2019
Merged
bors added a commit that referenced this pull request Sep 5, 2019
@bors
Auto merge of #64160 - Centril:rollup-vrfj1pt, r=Centril
a24f636 
Rollup of 15 pull requests

Successful merges:

 - #62860 (Stabilize checked_duration_since for 1.38.0)
 - #63549 (Rev::rposition counts from the wrong end)
 - #63985 (Stabilize pin_into_inner in 1.39.0)
 - #64005 (Add a `Place::is_indirect` method to determine whether a `Place` contains a `Deref` projection)
 - #64031 (Harden `param_attrs` test wrt. usage of a proc macro `#[attr]`)
 - #64038 (Check impl trait substs when checking for recursive types)
 - #64043 (Add some more tests for underscore imports)
 - #64092 (Update xLTO compatibility table in rustc book.)
 - #64110 (Refer to "`self` type" instead of "receiver type")
 - #64120 (Move path parsing earlier)
 - #64123 (Added warning around code with reference to uninit bytes)
 - #64128 (unused_parens: account for or-patterns and `&(mut x)`)
 - #64141 (Minimize uses of `LocalInternedString`)
 - #64142 (Fix doc links in `std::cmp` module)
 - #64148 (fix a few typos in comments)

Failed merges:

r? @ghost
@bors
Copy link
Contributor

bors commented Sep 5, 2019

☔ The latest upstream changes (presumably #64160) made this pull request unmergeable. Please resolve the merge conflicts.

@bors bors removed the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label Sep 5, 2019
@bors bors added the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Sep 5, 2019
@bors bors merged commit b6f9523 into rust-lang:master Sep 5, 2019
@tesuji tesuji deleted the fix-doc-cmp branch September 5, 2019 06:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ehuss ehuss ehuss left review comments

Assignees

@jonas-schievink jonas-schievink

Labels
S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@tesuji @jonas-schievink @bors @rust-highfive @ehuss