Mention Vec::into_boxed_slice in documentation of [T]::into_vec #42151
Conversation
`Vec::into_boxed_slice` and `[T]::into_vec` are inverses, so it makes sense to mention the other in their respective documentation for visibility. `Vec::into_boxed_slice` already mentions `[T]::into_vec`, but not the other way around until now.
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @BurntSushi (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
frewsxcv
added
the
A-docs
|
This LGTM, but I'm throwing it to @steveklabnik since it sounds like you wanted to look at this? |
src/libcollections/slice.rs
Outdated
| /// The resulting vector can be converted back into a box via | ||
| /// the [`into_boxed_slice`] method. | ||
| /// | ||
| /// [`into_boxed_slice`]: vec/struct.Vec.html#method.into_boxed_slice |
There was a problem hiding this comment.
unfortunately, I have a feeling this link won't work because this method appears on both the slice and Vec doc pages. as is, the link works on the slice page, but on the vec page, it would end up linking to std/vec/vec/struct.Vec.html#method.into_vec. we'll find out soon whether this passes the linkchecker on Travis CI, but i'm guessing this link will probably need to be removed
They had just brought it up on IRC so I had mentioned it; I'd be happy with anyone else merging 😄 @frewsxcv is right though; we cannot make this link right now due to a rustdoc bug |
carols10cents
added
the
S-waiting-on-author
The documentation for this method appears on multiple different pages, which causes the relative links to not always work.
|
I removed the link & Travis builds are passing. Let me know if anything more is needed. |
|
thanks! @bors r+ rollup |
|
📌 Commit 6e8e5c9 has been approved by |
Mention Vec::into_boxed_slice in documentation of [T]::into_vec This is a documentation fix. `Vec::into_boxed_slice` and `[T]::into_vec` are inverses, so it makes sense to mention the other in their respective documentation for visibility. `Vec::into_boxed_slice` already mentions `[T]::into_vec`, but not the other way around until now. Tagging @steveklabnik per his request.
This is a documentation fix.
Vec::into_boxed_sliceand[T]::into_vecare inverses, so it makes sense to mention the other in their respective documentation for visibility.Vec::into_boxed_slicealready mentions[T]::into_vec, but not the other way around until now.Tagging @steveklabnik per his request.