Skip to content

Unify titles in rustdoc book doc attributes chapter #90374

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
Merged
merged 1 commit into from
Oct 30, 2021
Merged

Unify titles in rustdoc book doc attributes chapter #90374

merged 1 commit into from
Oct 30, 2021

Conversation

GuillaumeGomez
Copy link
Member

As discussed in #90339.

I wasn't able to find out where the link to the titles was used so let's see if the CI fails. :)

r? @camelid

@GuillaumeGomez GuillaumeGomez added C-cleanup Category: PRs that clean code up or issues documenting cleanup. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Oct 28, 2021
@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 28, 2021
@bors
Copy link
Collaborator

bors commented Oct 28, 2021

☔ The latest upstream changes (presumably #90339) made this pull request unmergeable. Please resolve the merge conflicts.

@GuillaumeGomez GuillaumeGomez force-pushed the unify-rustdoc-book-titles branch from 9979e70 to 54c2f9d Compare October 28, 2021 13:58
@camelid
Copy link
Member

camelid commented Oct 28, 2021

I wasn't able to find out where the link to the titles was used so let's see if the CI fails. :)

CI won't catch all uses. You'll have to update at least this spot:

$ rg docno_inlinedocinline compiler/
compiler/rustc_passes/src/check_attr.rs
771:                    err.note("read https://doc.rust-lang.org/nightly/rustdoc/the-doc-attribute.html#docno_inlinedocinline for more information")

camelid
camelid reviewed Oct 28, 2021
View reviewed changes
Copy link
Member

@camelid camelid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

r=me with the following comments addressed and the error message I mentioned above updated (you'll have to bless tests as well)

Please make sure to use r=camelid rather than r+ :)

@camelid camelid added A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 28, 2021
@GuillaumeGomez GuillaumeGomez force-pushed the unify-rustdoc-book-titles branch from 54c2f9d to a2ff29f Compare October 29, 2021 12:00
@GuillaumeGomez
Copy link
Member Author

Instead of creating span, I simply wrote the title with h3 and code.

@GuillaumeGomez
Copy link
Member Author

@bors: r=camelid rollup

@bors
Copy link
Collaborator

bors commented Oct 29, 2021

📌 Commit a2ff29f17cdafec9d485efc7b4b34f04fb5bdc3e has been approved by camelid

@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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 29, 2021
@camelid
Copy link
Member

camelid commented Oct 29, 2021

@bors r-

@bors bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Oct 29, 2021
@camelid
Copy link
Member

camelid commented Oct 29, 2021

Instead of creating span, I simply wrote the title with h3 and code.

This might mess up the mdBook styling, and it means the new IDs won't exist. Please use span or similar instead.

@camelid
Copy link
Member

camelid commented Oct 29, 2021

Also, please update the error message I mentioned above.

@GuillaumeGomez GuillaumeGomez force-pushed the unify-rustdoc-book-titles branch from a2ff29f to 9829811 Compare October 29, 2021 18:13
@GuillaumeGomez
Copy link
Member Author

Updated! I'll let you handle the r+ this time. ;)

camelid
camelid reviewed Oct 29, 2021
View reviewed changes
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@GuillaumeGomez GuillaumeGomez force-pushed the unify-rustdoc-book-titles branch from 9829811 to 0c70831 Compare October 29, 2021 19:28
@camelid
Copy link
Member

camelid commented Oct 29, 2021

Thanks!

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Oct 29, 2021

📌 Commit 0c70831 has been approved by camelid

@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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 29, 2021
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Oct 30, 2021
@matthiaskrgr
Rollup merge of rust-lang#90374 - GuillaumeGomez:unify-rustdoc-book-t…
e8991e9 
…itles, r=camelid

Unify titles in rustdoc book doc attributes chapter

As discussed in rust-lang#90339.

I wasn't able to find out where the link to the titles was used so let's see if the CI fails. :)

r? `@camelid`
@matthiaskrgr matthiaskrgr mentioned this pull request Oct 30, 2021
Closed
@matthiaskrgr matthiaskrgr mentioned this pull request Oct 30, 2021
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Oct 30, 2021
@bors
Auto merge of rust-lang#90416 - matthiaskrgr:rollup-55lzqng, r=matthi…
9f13083 
…askrgr

Rollup of 8 pull requests

Successful merges:

 - rust-lang#89876 (Make most std::ops traits const on numeric types)
 - rust-lang#90371 (Fix incorrect doc link)
 - rust-lang#90374 (Unify titles in rustdoc book doc attributes chapter)
 - rust-lang#90377 (Make `core::slice::from_raw_parts[_mut]` const)
 - rust-lang#90395 (Restrict liveness of mutable borrow of inner infcx in ConstInferUnifier::consts)
 - rust-lang#90396 (Prevent type flags assertions being thrown in default_anon_const_substs if errors occurred)
 - rust-lang#90402 (Add a few query descriptions)
 - rust-lang#90412 (Remove unnecessary `macro_use`s in rustdoc)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit a213740 into rust-lang:master Oct 30, 2021
@rustbot rustbot added this to the 1.58.0 milestone Oct 30, 2021
@GuillaumeGomez GuillaumeGomez deleted the unify-rustdoc-book-titles branch October 30, 2021 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@camelid camelid camelid left review comments

Assignees

@camelid camelid

Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools C-cleanup Category: PRs that clean code up or issues documenting cleanup. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.58.0
Development

Successfully merging this pull request may close these issues.
6 participants
@GuillaumeGomez @bors @camelid @rust-log-analyzer @rust-highfive @rustbot