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

add a section to the Rustdoc Book about the in-doc settings #55165

Closed
QuietMisdreavus opened this issue Oct 17, 2018 · 3 comments · Fixed by #110641
Closed

add a section to the Rustdoc Book about the in-doc settings #55165

QuietMisdreavus opened this issue Oct 17, 2018 · 3 comments · Fixed by #110641
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-feature-request Category: A feature request, i.e: not implemented / a PR. P-medium Medium priority T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@QuietMisdreavus
Copy link
Member

Rustdoc has accumulated a handful of settings that users can toggle as they read docs, but we don't document them anywhere. It would be ideal if we had some documentation about these options in the Rustdoc Book that described their functionality better than the short descriptions shown on the settings page itself.

image
@QuietMisdreavus QuietMisdreavus 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 C-feature-request Category: A feature request, i.e: not implemented / a PR. labels Oct 17, 2018
@steveklabnik steveklabnik added the P-medium Medium priority label Dec 27, 2018
@DevQps
Copy link
Contributor

DevQps commented Mar 30, 2019 •
edited
Loading

@QuietMisdreavus I don't mind picking this up, unless you want to do this yourself! I do however have some questions!:

  • The Rustdoc book you mean is this one right?
  • Do you suggest adding a new section to this book or would you include it in an already existing section?
  • What do you believe is not clear / elaborated enough in the short descriptions? I do not know the specific details of each switch are there any side-effects that are not in the short description?

@steveklabnik
Copy link
Member

Triage: no changes.

The rustdoc book is that one, @DevQps ! I am not a rustdoc maintainer these days (cc @GuillaumeGomez ) but I would probably make a new section. While the short description is good, I think it would make sense to show the options in slightly more detail, for example, maybe a before/after.

@DevQps
Copy link
Contributor

DevQps commented May 24, 2020

@steveklabnik Bit of a late reply :) @GuillaumeGomez Do you have something to add to this? Otherwise I will follow what Steve said!

@GuillaumeGomez GuillaumeGomez mentioned this issue Apr 21, 2023
Merged
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Apr 26, 2023
@matthiaskrgr
Rollup merge of rust-lang#110641 - GuillaumeGomez:rustdoc-in-doc-sett…
0b395f9 
…ings, r=notriddle

Add new rustdoc book chapter to describe in-doc settings

Fixes rust-lang#55165.

I continue going through old rustdoc issues. This one made a lot of sense so decided to add the missing chapter.

r? `@notriddle`
@bors bors closed this as completed in 66a5ac0 Apr 26, 2023
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 C-feature-request Category: A feature request, i.e: not implemented / a PR. P-medium Medium priority 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.

Add new rustdoc book chapter to describe in-doc settings GuillaumeGomez/rust
3 participants
@steveklabnik @QuietMisdreavus @DevQps