-
Notifications
You must be signed in to change notification settings - Fork 13.3k
Fix a few links in the docs #37316
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.
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
Merged
Merged
Fix a few links in the docs #37316
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -182,11 +182,11 @@ pub trait Drop { | |
/// After this function is over, the memory of `self` will be deallocated. | ||
/// | ||
/// This function cannot be called explicitly. This is compiler error | ||
/// [0040]. However, the [`std::mem::drop`] function in the prelude can be | ||
/// [E0040]. However, the [`std::mem::drop`] function in the prelude can be | ||
/// used to call the argument's `Drop` implementation. | ||
/// | ||
/// [0040]: https://doc.rust-lang.org/error-index.html#E0040 | ||
/// [`std::mem::drop`]: https://doc.rust-lang.org/std/mem/fn.drop.html | ||
/// [E0040]: ../../error-index.html#E0040 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same comment. |
||
/// [`std::mem::drop`]: ../../std/mem/fn.drop.html | ||
/// | ||
/// # Panics | ||
/// | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -914,6 +914,7 @@ impl<'a> cmp::Ord for Components<'a> { | |
/// [`Path`]: struct.Path.html | ||
/// [`push`]: struct.PathBuf.html#method.push | ||
/// [`set_extension`]: struct.PathBuf.html#method.set_extension | ||
/// [`Deref`]: ../ops/trait.Deref.html | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nice catch! |
||
/// | ||
/// More details about the overall approach can be found in | ||
/// the module documentation. | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this is a good idea. If you build docs locally, you'' have troubles.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you mean? The error index is part of the local docs so this is no different to linking to the book like this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you run
make docs
(or any equivalent) then yes, but what if you just build libstd docs?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well then these links won't work and neither will links to the book like on
std::sync::Arc
andstd::borrow::Borrow
for example. I don't consider that a problem because if you want to build thestd
docs without any dead links you need to usemake docs
anyway. The advantages of using relative links like this are: they work offline, they link to the same version of the docs you're already viewing and linkchecker can check them.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hum, I see your point. I guess it's okay then.