Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Improve "visibility" of rustdoc books ("stable" and unstable ones) #75520

Open
GuillaumeGomez opened this issue Aug 14, 2020 · 2 comments
Open

Improve "visibility" of rustdoc books ("stable" and unstable ones) #75520

GuillaumeGomez opened this issue Aug 14, 2020 · 2 comments
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@GuillaumeGomez
Copy link
Member

Currently, very few people know the existence of https://doc.rust-lang.org/nightly/nightly-rustc/rustdoc/ and of https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html, which is a shame considering how huge is the amount of available options and tips.

I suggested adding those links (the unstable one only in unstable build of course) at the beginning of the "help display".
@GuillaumeGomez GuillaumeGomez added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools labels Aug 14, 2020
@AndyGauge
Copy link
Contributor

I'm going to try to implement this.

@AndyGauge
Copy link
Contributor

AndyGauge commented Aug 26, 2020 •
edited
Loading 

andy@DESKTOP-T75H07P:~/rust/build/x86_64-unknown-linux-gnu/stage2/bin$ ./rustdoc --help
See http://doc.rust-lang.org/rustdoc for more information
rustdoc [options] <input>

Options:

I was able to get rustdoc to compile with a little tooltip!

@AndyGauge AndyGauge mentioned this issue Sep 7, 2020
Closed
@GuillaumeGomez GuillaumeGomez mentioned this issue Oct 19, 2020
Merged
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this issue Oct 19, 2020
@GuillaumeGomez
Rollup merge of rust-lang#78103 - GuillaumeGomez:rustdoc-book, r=jyn514
cbcf8d4 
Add link to rustdoc book in rustdoc help popup

Part of rust-lang#75520.

It looks like this:

![Screenshot from 2020-10-19 13-46-02](https://user-images.githubusercontent.com/3050060/96446334-934d6900-1211-11eb-8fdc-133fecc8c30d.png)
![Screenshot from 2020-10-19 13-43-46](https://user-images.githubusercontent.com/3050060/96446335-947e9600-1211-11eb-955c-68af5292aecc.png)
![Screenshot from 2020-10-19 13-37-26](https://user-images.githubusercontent.com/3050060/96446337-947e9600-1211-11eb-9a2e-399b99178a65.png)

r? @jyn514
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve Rustdoc self-documentation visibility by displaying links in usage AndyGauge/rust
3 participants
@Manishearth @GuillaumeGomez @AndyGauge