rustdoc: Get rid of `clean::TypeKind` #84464

jyn514 · 2021-04-23T01:30:23Z

It does exactly the same thing as ItemType.

rust-highfive · 2021-04-23T01:30:26Z

(rust-highfive has picked a reviewer for you, use r? to override)

CraftSpider

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.

jyn514 · 2021-04-23T01:53:47Z

@CraftSpider ItemType has a custom Serialize impl that needs to match the JSON frontend:

rust/src/librustdoc/formats/item_type.rs

Line 57 in 7f4afdf

(*self as u8).serialize(serializer)

rust/src/librustdoc/formats/item_type.rs

Lines 13 to 21 in 7f4afdf

    
           /// 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.

jyn514 · 2021-04-23T03:03:47Z

@bors r=CraftSpider

bors · 2021-04-23T03:03:49Z

📌 Commit 6c066ab has been approved by CraftSpider

rustdoc: Get rid of `clean::TypeKind` It does exactly the same thing as ItemType.

JohnTitor · 2021-04-23T18:46:09Z

@bors r-
This PR now has a merge conflict.

jyn514 · 2021-04-23T19:09:19Z

@bors r=CraftSpider

bors · 2021-04-23T19:09:20Z

📌 Commit d17b79147c580dc94bd9b40e14ca76ce76f9367a has been approved by CraftSpider

jyn514 · 2021-04-23T19:46:01Z

@bors r-

This was missed a while ago when support for proc-macro attributes was first added.

jyn514 · 2021-04-23T19:58:42Z

@bors r=CraftSpider

bors · 2021-04-23T19:58:43Z

📌 Commit ab54197 has been approved by CraftSpider

rustdoc: Get rid of `clean::TypeKind` It does exactly the same thing as ItemType.

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}` in `1.53.0`) - rust-lang#84179 (Explicitly implement `!Send` and `!Sync` for `sys::{Args, Env}`) - rust-lang#84427 (Update Clippy) - rust-lang#84459 (rustdoc: Turn `JsonRenderer::mod_item_in` into `unreachable!()`) - rust-lang#84460 (rustdoc: Remove unnecessary `is_crate` field 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

jyn514 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 Apr 23, 2021

rust-highfive assigned CraftSpider Apr 23, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Apr 23, 2021

CraftSpider approved these changes Apr 23, 2021

View reviewed changes

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 23, 2021

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Apr 23, 2021

Rollup merge of rust-lang#84464 - jyn514:type-kind, r=CraftSpider

f75bb0c

rustdoc: Get rid of `clean::TypeKind` It does exactly the same thing as ItemType.

GuillaumeGomez mentioned this pull request Apr 23, 2021

Rollup of 12 pull requests #84473

Closed

Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Apr 23, 2021

Rollup merge of rust-lang#84464 - jyn514:type-kind, r=CraftSpider

72d5ed0

rustdoc: Get rid of `clean::TypeKind` It does exactly the same thing as ItemType.

Dylan-DPC-zz mentioned this pull request Apr 23, 2021

Rollup of 13 pull requests #84477

Closed

JohnTitor added a commit to JohnTitor/rust that referenced this pull request Apr 23, 2021

Rollup merge of rust-lang#84464 - jyn514:type-kind, r=CraftSpider

3ed8bba

rustdoc: Get rid of `clean::TypeKind` It does exactly the same thing as ItemType.

JohnTitor mentioned this pull request Apr 23, 2021

Rollup of 11 pull requests #84483

Closed

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 Apr 23, 2021

This comment has been minimized.

Sign in to view

jyn514 force-pushed the type-kind branch from 6c066ab to d17b791 Compare April 23, 2021 19:08

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 Apr 23, 2021

This comment has been minimized.

Sign in to view

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 Apr 23, 2021

jyn514 added 6 commits April 23, 2021 15:56

Take ItemType instead of TypeKind in record_extern_fqn

1481af9

Use ItemType in cache

f3ef4b2

Remove TypeKind

0a9b2ca

Remove unused impl Clean<ItemType> for DefKind

8fd29bf

Don't repeat hir::def::DefKind so much

18ee323

Fix macro bug in impl From<DefKind> for ItemType

ab54197

This was missed a while ago when support for proc-macro attributes was first added.

jyn514 force-pushed the type-kind branch from d17b791 to ab54197 Compare April 23, 2021 19:57

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 Apr 23, 2021

Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Apr 24, 2021

Rollup merge of rust-lang#84464 - jyn514:type-kind, r=CraftSpider

0dd60e1

rustdoc: Get rid of `clean::TypeKind` It does exactly the same thing as ItemType.

Dylan-DPC-zz mentioned this pull request Apr 24, 2021

Rollup of 7 pull requests #84509

Closed

Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Apr 24, 2021

Rollup merge of rust-lang#84464 - jyn514:type-kind, r=CraftSpider

e03cdb6

rustdoc: Get rid of `clean::TypeKind` It does exactly the same thing as ItemType.

Dylan-DPC-zz mentioned this pull request Apr 24, 2021

Rollup of 7 pull requests #84512

Closed

JohnTitor added a commit to JohnTitor/rust that referenced this pull request Apr 24, 2021

Rollup merge of rust-lang#84464 - jyn514:type-kind, r=CraftSpider

3276103

rustdoc: Get rid of `clean::TypeKind` It does exactly the same thing as ItemType.

JohnTitor mentioned this pull request Apr 24, 2021

Rollup of 6 pull requests #84517

Closed

JohnTitor added a commit to JohnTitor/rust that referenced this pull request Apr 24, 2021

Rollup merge of rust-lang#84464 - jyn514:type-kind, r=CraftSpider

1923a2f

rustdoc: Get rid of `clean::TypeKind` It does exactly the same thing as ItemType.

This was referenced Apr 24, 2021

Rollup of 9 pull requests #84524

Closed

Rollup of 8 pull requests #84525

Merged

bors merged commit e25c5e2 into rust-lang:master Apr 24, 2021

rustbot added this to the 1.53.0 milestone Apr 24, 2021

jyn514 deleted the type-kind branch April 24, 2021 23:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

rustdoc: Get rid of `clean::TypeKind` #84464

rustdoc: Get rid of `clean::TypeKind` #84464

jyn514 commented Apr 23, 2021

rust-highfive commented Apr 23, 2021

CraftSpider left a comment

jyn514 commented Apr 23, 2021 •

edited

Loading

jyn514 commented Apr 23, 2021

bors commented Apr 23, 2021

JohnTitor commented Apr 23, 2021

This comment has been minimized.

jyn514 commented Apr 23, 2021

bors commented Apr 23, 2021

This comment has been minimized.

jyn514 commented Apr 23, 2021

jyn514 commented Apr 23, 2021

bors commented Apr 23, 2021

rustdoc: Get rid of clean::TypeKind #84464

rustdoc: Get rid of clean::TypeKind #84464

Conversation

jyn514 commented Apr 23, 2021

rust-highfive commented Apr 23, 2021

CraftSpider left a comment

Choose a reason for hiding this comment

jyn514 commented Apr 23, 2021 • edited Loading

jyn514 commented Apr 23, 2021

bors commented Apr 23, 2021

JohnTitor commented Apr 23, 2021

This comment has been minimized.

jyn514 commented Apr 23, 2021

bors commented Apr 23, 2021

This comment has been minimized.

jyn514 commented Apr 23, 2021

jyn514 commented Apr 23, 2021

bors commented Apr 23, 2021

rustdoc: Get rid of `clean::TypeKind` #84464

rustdoc: Get rid of `clean::TypeKind` #84464

jyn514 commented Apr 23, 2021 •

edited

Loading