-
Notifications
You must be signed in to change notification settings - Fork 13.8k
more concrete source url of std docs [V2] #134241
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
Conversation
Genuine question — what's the goal here? I don't find the existing link confusing at all. |
to help people finding target page more quickly & easily. only the repo url is not enough, the std is deeply hidden in the repo's tree (from newbies view). |
I find it's quite obvious, as it's in the top-level r? libs-api |
library/std/src/lib.rs
Outdated
//! The source for this documentation can be found on | ||
//! [GitHub](https://github.com/rust-lang/rust). | ||
//! [GitHub](https://github.com/rust-lang/rust) | ||
//!(e.g. [here](https://github.com/rust-lang/rust/blob/master/library/std/src/lib.rs)). |
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.
The character at the beginning of this line is a Unicode "Fullwidth Exclamation Mark", which is not an ASCII exclamation mark. So this line would not be treated as documentation by rustdoc. It is just a comment.
IMO the original wording and link are fine as is. I would accept something like: The source for this documentation can be found on GitHub in the 'library/std/' directory. |
r? dtolnay |
Could not assign reviewer from: |
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.
Thanks!
@bors r+ rollup |
r? jhpratt
since you have reivewed #134193
Now the repository url is reserved, I just add another concrete url as an example, to help people finding target page more quickly&easily.