Skip to content

Move to intra-doc links in library/std/src/path.rs #75293

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom
Merged
merged 1 commit into from
Aug 9, 2020
Merged

Move to intra-doc links in library/std/src/path.rs #75293

merged 1 commit into from
Aug 9, 2020

Conversation

poliorcetics
Copy link
Contributor

Helps with #75080.

@rustbot modify labels: T-doc, A-intra-doc-links, T-rustdoc

Known issue: The following links are broken (they are inside trait impls, undocumented in this file, inheriting from the original doc):

  • [Hasher]
  • [Self] (referencing ../primitive.slice.html)
  • [Ordering]

@rustbot rustbot added A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Aug 8, 2020
@rust-highfive
Copy link
Contributor

r? @hanna-kruppe

(rust_highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 8, 2020
@jyn514
Copy link
Member

jyn514 commented Aug 8, 2020

The following links are broken (they are inside trait impls, undocumented in this file, inheriting from the original doc):

This would be fixed by #75176 if I could get it working.

jyn514
jyn514 approved these changes Aug 8, 2020
View reviewed changes
Copy link
Member

@jyn514 jyn514 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great ❤️ Thanks so much!

library/std/src/path.rs
@@ -1812,7 +1756,7 @@ impl Path {
/// Note that validation is performed because non-UTF-8 strings are
/// perfectly valid for some OS.
///
/// [`&str`]: ../primitive.str.html
/// [`&str`]: str
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#63351 😢

library/std/src/path.rs
/// [`Cow<str>`]: ../borrow/enum.Cow.html
/// [U+FFFD]: ../char/constant.REPLACEMENT_CHARACTER.html
/// [`Cow<str>`]: Cow
/// [U+FFFD]: super::char::REPLACEMENT_CHARACTER
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: I think this would be more clear as

Suggested change
/// [U+FFFD]: super::char::REPLACEMENT_CHARACTER
/// [U+FFFD]: crate::char::REPLACEMENT_CHARACTER

library/std/src/path.rs
@@ -1832,8 +1776,8 @@ impl Path {
/// Any non-Unicode sequences are replaced with
/// [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
///
/// [`Cow<str>`]: ../borrow/enum.Cow.html
/// [U+FFFD]: ../char/constant.REPLACEMENT_CHARACTER.html
/// [`Cow<str>`]: Cow
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#62834

@hanna-kruppe
Copy link
Contributor

LGTM at a glance. @jyn514 is there a reason why you didn't r+ yet?

@jyn514
Copy link
Member

jyn514 commented Aug 9, 2020

I was waiting to see if @poliorcetics wanted to address the nit. But it can always be fixed in a follow-up PR.

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Aug 9, 2020

📌 Commit 6d77e40 has been approved by jyn514

@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 Aug 9, 2020
@bors
Copy link
Collaborator

bors commented Aug 9, 2020

⌛ Testing commit 6d77e40 with merge 8bc801b...

@poliorcetics
Copy link
Contributor Author

Ah sorry, I didn't have time yesterday and forgot all about it till I got your ping today.

I plan to continue working on the original issue, if I haven't revisited it once this is merged remind me, I'll do it

@bors
Copy link
Collaborator

bors commented Aug 9, 2020

☀️ Test successful - checks-actions, checks-azure
Approved by: jyn514
Pushing 8bc801b to master...

@bors bors added the merged-by-bors This PR was explicitly merged by bors. label Aug 9, 2020
@bors bors merged commit 8bc801b into rust-lang:master Aug 9, 2020
@poliorcetics poliorcetics deleted the intra-doc-links-std-path branch August 9, 2020 14:50
@jyn514 jyn514 removed the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Aug 25, 2020
@cuviper cuviper added this to the 1.47.0 milestone May 2, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@jyn514 jyn514 jyn514 approved these changes

Assignees

@hanna-kruppe hanna-kruppe

Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name merged-by-bors This PR was explicitly merged by bors. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Milestone
1.47.0
Development

Successfully merging this pull request may close these issues.
7 participants
@poliorcetics @rust-highfive @jyn514 @hanna-kruppe @bors @cuviper @rustbot