Update lots of doc links to use item paths instead of file paths #1223
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.
Hi! I noticed that a lot of intra-doc links in
rayon-core
andrayon
uses webpage links (i.e.iter/trait.ParallelExtend.html#tymethod.par_extend
) instead of item paths (i.e.iter::ParallelExtend::par_extend()
).This PR converts as many intra-doc links as I could find into item paths. This ensures that if Rustdoc ever changes how its documentation is structured in the file system (unlikely, but not impossible),
rayon
andrayon-core
's docs will continue to function as normal.This PR also fixes a couple small pieces of documentation which I assume were meant to link to another item.
I made sure to double-check all of my work - and especially made sure the links would work when using
cargo +1.63 doc
(the msrv of Rayon) - but if you find any documentation links I missed, or any that are now broken, please let me know.Notes:
rayon/rayon-core/src/lib.rs
Line 414 in d179ea9
crossbeam
were a dependency ofrayon-core
, I would be able to change this to an item path. But alas, it is not.rayon/rayon-core/src/join/mod.rs
Line 41 in d179ea9
rayon::slice::ParallelSliceMut::par_sort()
) results in a broken link warning.rayon/src/array.rs
Line 6 in d179ea9
std::array
links to thestd::array
module rather than the[T; N]
primitive.