Clean up rustdoc IDs #86819
Merged
Clean up rustdoc IDs #86819
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
GuillaumeGomez
added
C-cleanup
rust-highfive
added
the
S-waiting-on-review
jyn514
reviewed
Jul 3, 2021
| // This is the list of IDs used by rustdoc sections. | ||
| map.insert("fields".to_owned(), 1); | ||
| map.insert("variants".to_owned(), 1); | ||
| map.insert("implementors-list".to_owned(), 1); | ||
| map.insert("synthetic-implementors-list".to_owned(), 1); | ||
| map.insert("foreign-impls".to_owned(), 1); |
There was a problem hiding this comment.
What does "rustdoc templates" mean in this context? I assume it's not related to Tera templates since we only just now started migrating those. https://github.com/rust-lang/rust/blob/398616f4d4b6854d37db994049a186711a05cc76/src/librustdoc/html/markdown.rs#L1361
There was a problem hiding this comment.
It refers to the generation of HTML in rustdoc. Not the best naming but I guess at the time it sounded like a good enough idea. :)
There was a problem hiding this comment.
Gotcha. Do you mind updating the comment to be more clear? Something like "This is the list of IDs used in HTML generated in Rust" and then "in JavaScript" respectively.
GuillaumeGomez
force-pushed
the
cleanup-rustdoc-ids
branch
from
398616f
to
8c2a37a
Compare
|
Done. I moved the JS ID at the top and reworded the other comments. |
|
Since I fixed the nits, let's go! @bors: r=jyn514 rollup |
|
📌 Commit 8c2a37a has been approved by |
bors
added
S-waiting-on-bors
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jul 7, 2021
Rollup of 8 pull requests Successful merges: - rust-lang#80918 (Add Integer::log variants) - rust-lang#86717 (Rename some Rust 2021 lints to better names ) - rust-lang#86819 (Clean up rustdoc IDs) - rust-lang#86880 (Test ManuallyDrop::clone_from.) - rust-lang#86906 (Replace deprecated compare_and_swap and fix typo in core::sync::atomic::{fence, compiler_fence} docs) - rust-lang#86907 (Migrate `cpu-usage-over-time.py` to Python 3) - rust-lang#86916 (rewrote documentation for thread::yield_now()) - rust-lang#86919 (Update books) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
flip1995
pushed a commit
to flip1995/rust
that referenced
this pull request
Jul 15, 2021
Rollup of 8 pull requests Successful merges: - rust-lang#80918 (Add Integer::log variants) - rust-lang#86717 (Rename some Rust 2021 lints to better names ) - rust-lang#86819 (Clean up rustdoc IDs) - rust-lang#86880 (Test ManuallyDrop::clone_from.) - rust-lang#86906 (Replace deprecated compare_and_swap and fix typo in core::sync::atomic::{fence, compiler_fence} docs) - rust-lang#86907 (Migrate `cpu-usage-over-time.py` to Python 3) - rust-lang#86916 (rewrote documentation for thread::yield_now()) - rust-lang#86919 (Update books) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I cherry-picked the commit from #86178. It adds missing rustdoc IDs (for the HTML) and remove unused ones.
cc @camelid
r? @jyn514