You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Quite a few of the links in the core module concerning redirection to additional primitive type documentation are broken. I noticed in #30214 that there seemed to be a consensus with linking across to std module documentation from the core module. This is what I've done with the core modules for primitive types.
If the changes here are good to go forward with, I'll happily tend to adding more documentation links for the extension traits in the aforementioned issue if need be.
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @steveklabnik (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.
Hey @miqid ! Thanks for this. I was wondering what the right way to do this would be, and this is an interesting approach. Hmm...
So, one weird thing is that the primitive types docs are actually in the primitive_doc submodule of std, but not on the type. So some of these changes are things that were never renered in the first place; I believe it's all of the parts of this patch which didn't have links before, but where you're adding them. So we should leave those ones alone, and focus on fixing the links that do exist. Does that make sense?
Just to clarify, you want me to back out of any modifications that introduce new links? I can do so. I just felt that it's convenient to provide those links for easy navigation around the API documentation. :-)
Also, with regards to rustc_unicode::char and std::char, both, at least when I build the documentation, have a corresponding documentation page—perhaps this is another problem and they need to be suppressed instead? So I'm not sure by what you mean when you say that they are never rendered anywhere.
Just to clarify, you want me to back out of any modifications that introduce new links? I can do so. I just felt that it's convenient to provide those links for easy navigation around the API documentation. :-)
Yeah, the issue here though is that these will never end up on a page, so the links end up being distracting without being helpful, at least, in my opinion.
Also, with regards to rustc_unicode::char and std::char,
Yeah, those modules should be, it's the primitive types that aren't.
Hello.
Quite a few of the links in the `core` module concerning redirection to additional primitive type documentation are broken. I noticed in rust-lang#30214 that there seemed to be a consensus with linking across to `std` module documentation from the `core` module. This is what I've done with the `core` modules for primitive types.
If the changes here are good to go forward with, I'll happily tend to adding more documentation links for the extension traits in the aforementioned issue if need be.
r? @steveklabnik
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
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.
Hello.
Quite a few of the links in the
coremodule concerning redirection to additional primitive type documentation are broken. I noticed in #30214 that there seemed to be a consensus with linking across tostdmodule documentation from thecoremodule. This is what I've done with thecoremodules for primitive types.If the changes here are good to go forward with, I'll happily tend to adding more documentation links for the extension traits in the aforementioned issue if need be.
r? @steveklabnik