rustdoc: Get rid of clean::TypeKind by jyn514 · Pull Request #84464 · rust-lang/rust (original) (raw)
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 andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Conversation13 Commits6 Checks0 Files changed
Conversation
This file contains hidden or 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
[ Show hidden characters]({{ revealButtonHref }})
It does exactly the same thing as ItemType.
Category: PRs that clean code up or issues documenting cleanup.
Relevant to the rustdoc team, which will review and decide on the PR/issue.
labels
r? @CraftSpider
(rust-highfive has picked a reviewer for you, use r? to override)
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Only question is, what's the reasoning for keeping ItemType over TypeKind? I'm guessing because TypeKind looks like it was only used as a brief stand-in for ItemType anyways. Otherwise looks good, will approve assuming tests pass.
@CraftSpider ItemType has a custom Serialize impl that needs to match the JSON frontend:
| (*self as u8).serialize(serializer) |
|---|
| /// The search index uses item types encoded as smaller numbers which equal to |
|---|
| /// discriminants. JavaScript then is used to decode them into the original value. |
| /// Consequently, every change to this type should be synchronized to |
| /// the `itemTypes` mapping table in `html/static/main.js`. |
| /// |
| /// In addition, code in `html::render` uses this enum to generate CSS classes, page prefixes, and |
| /// module headings. If you are adding to this enum and want to ensure that the sidebar also prints |
| /// a heading, edit the listing in `html/render.rs`, function `sidebar_module`. This uses an |
| /// ordering based on a helper function inside `item_module`, in the same file. |
📌 Commit 6c066ab has been approved by CraftSpider
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
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request
rustdoc: Get rid of clean::TypeKind
It does exactly the same thing as ItemType.
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request
rustdoc: Get rid of clean::TypeKind
It does exactly the same thing as ItemType.
JohnTitor added a commit to JohnTitor/rust that referenced this pull request
rustdoc: Get rid of clean::TypeKind
It does exactly the same thing as ItemType.
@bors r-
This PR now has a merge conflict.
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
This comment has been minimized.
📌 Commit d17b79147c580dc94bd9b40e14ca76ce76f9367a has been approved by CraftSpider
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
This comment has been minimized.
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
This was missed a while ago when support for proc-macro attributes was first added.
📌 Commit ab54197 has been approved by CraftSpider
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
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request
rustdoc: Get rid of clean::TypeKind
It does exactly the same thing as ItemType.
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request
rustdoc: Get rid of clean::TypeKind
It does exactly the same thing as ItemType.
JohnTitor added a commit to JohnTitor/rust that referenced this pull request
rustdoc: Get rid of clean::TypeKind
It does exactly the same thing as ItemType.
JohnTitor added a commit to JohnTitor/rust that referenced this pull request
rustdoc: Get rid of clean::TypeKind
It does exactly the same thing as ItemType.
This was referenced
Apr 24, 2021
bors added a commit to rust-lang-ci/rust that referenced this pull request
Rollup of 8 pull requests
Successful merges:
- rust-lang#83519 (Implement a lint that highlights all moves larger than a configured limit)
- rust-lang#84105 (stabilize
core::array::{from_ref,from_mut}in1.53.0) - rust-lang#84179 (Explicitly implement
!Sendand!Syncforsys::{Args, Env}) - rust-lang#84427 (Update Clippy)
- rust-lang#84459 (rustdoc: Turn
JsonRenderer::mod_item_inintounreachable!()) - rust-lang#84460 (rustdoc: Remove unnecessary
is_cratefield from doctree::Module and clean::Module) - rust-lang#84464 (rustdoc: Get rid of
clean::TypeKind) - rust-lang#84518 (Clean up DOM strings)
Failed merges:
r? @ghost
@rustbot modify labels: rollup
Labels
Category: PRs that clean code up or issues documenting cleanup.
Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Relevant to the rustdoc team, which will review and decide on the PR/issue.