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.

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

Add new rustdoc book chapter to describe in-doc settings #110641

Merged
merged 1 commit into from
Apr 26, 2023

Conversation

GuillaumeGomez
Copy link
Member

Fixes #55165.

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

r? @notriddle

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Apr 21, 2023
@rust-log-analyzer

This comment has been minimized.

@GuillaumeGomez GuillaumeGomez force-pushed the rustdoc-in-doc-settings branch from 5dff651 to e5a2031 Compare April 21, 2023 13:13
src/doc/rustdoc/src/in-doc-settings.md Outdated Show resolved Hide resolved
src/doc/rustdoc/src/in-doc-settings.md Outdated Show resolved Hide resolved
src/doc/rustdoc/src/in-doc-settings.md Outdated Show resolved Hide resolved
src/doc/rustdoc/src/in-doc-settings.md Outdated Show resolved Hide resolved
src/doc/rustdoc/src/in-doc-settings.md Outdated Show resolved Hide resolved
src/doc/rustdoc/src/SUMMARY.md Outdated Show resolved Hide resolved
@GuillaumeGomez GuillaumeGomez force-pushed the rustdoc-in-doc-settings branch 2 times, most recently from 5878869 to 2628c0b Compare April 22, 2023 12:27
@GuillaumeGomez
Copy link
Member Author

Applied suggestions and made this new chapter a new sub-chapter of "how to read rustdoc output".

@GuillaumeGomez GuillaumeGomez force-pushed the rustdoc-in-doc-settings branch from 2628c0b to 1c3efc6 Compare April 22, 2023 21:17
@notriddle
Copy link
Contributor

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Apr 25, 2023

📌 Commit 1c3efc6 has been approved by notriddle

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 25, 2023
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Apr 26, 2023
…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 added a commit to rust-lang-ci/rust that referenced this pull request Apr 26, 2023
…iaskrgr

Rollup of 10 pull requests

Successful merges:

 - rust-lang#108760 (Add lint to deny diagnostics composed of static strings)
 - rust-lang#109444 (Change tidy error message for TODOs)
 - rust-lang#110419 (Spelling library)
 - rust-lang#110550 (Suggest deref on comparison binop RHS even if type is not Copy)
 - rust-lang#110641 (Add new rustdoc book chapter to describe in-doc settings)
 - rust-lang#110798 (pass `unused_extern_crates` in `librustdoc::doctest::make_test`)
 - rust-lang#110819 (simplify TrustedLen impls)
 - rust-lang#110825 (diagnostics: add test case for already-solved issue)
 - rust-lang#110835 (Make some region folders a little stricter.)
 - rust-lang#110847 (rustdoc-json: Time serialization.)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 66a5ac0 into rust-lang:master Apr 26, 2023
@rustbot rustbot added this to the 1.71.0 milestone Apr 26, 2023
@GuillaumeGomez GuillaumeGomez deleted the rustdoc-in-doc-settings branch April 27, 2023 10:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add a section to the Rustdoc Book about the in-doc settings
5 participants