rustdoc: add support for type filters in arguments and generics#108629
rustdoc: add support for type filters in arguments and generics#108629bors merged 2 commits intorust-lang:masterfrom
Conversation
|
r? @jsha (rustbot has picked a reviewer for you, use r? to override) |
|
Some changes occurred in HTML/CSS/JS. cc @GuillaumeGomez, @Folyd, @jsha |
b865e9b to
551dbbc
Compare
1c122bd to
02d417b
Compare
|
@rfcbot fcp merge |
|
Team member @notriddle has proposed to merge this. The next step is review by the rest of the tagged team members: No concerns currently listed. Once a majority of reviewers approve (and at most 2 approvals are outstanding), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up! See this document for info about what commands tagged team members can give me. |
|
Overall, looks good to me. Just needs an update in the help popup docs about search and eventually in the rustdoc book but I don't remember us having a chapter about search, might be worth adding one at some point. |
|
☔ The latest upstream changes (presumably #108677) made this pull request unmergeable. Please resolve the merge conflicts. |
884687a to
78812cf
Compare
|
Can you post some screenshots or examples of what this actually enables? |
|
Using this feature allows you to distinguish multiple items with the same name, but different kinds, when searching by function signature. In the standard library, that's This means I should be able to search Footnotes
|
|
Ah, makes sense to me |
We do have a small section already that could be expanded: https://doc.rust-lang.org/nightly/rustdoc/how-to-read-rustdoc.html#the-search-interface |
8451c01 to
163ccab
Compare
|
☔ The latest upstream changes (presumably #109056) made this pull request unmergeable. Please resolve the merge conflicts. |
e9a2629 to
3f18ead
Compare
|
🔔 This is now entering its final comment period, as per the review above. 🔔 |
|
☔ The latest upstream changes (presumably #109376) made this pull request unmergeable. Please resolve the merge conflicts. |
This makes sense, since the search index has the information in it, and it's more useful for function signature searches since a function signature search's item type is, by definition, some type of function (there's more than one, but not very many).
3f18ead to
cae4385
Compare
|
The final comment period, with a disposition to merge, as per the review above, is now complete. As the automated representative of the governance process, I would like to thank the author for their work and everyone else who contributed. This will be merged soon. |
|
@bors r+ rollup |
…iaskrgr Rollup of 9 pull requests Successful merges: - rust-lang#108629 (rustdoc: add support for type filters in arguments and generics) - rust-lang#108924 (panic_immediate_abort requires abort as a panic strategy) - rust-lang#108961 (Refine error spans for const args in hir typeck) - rust-lang#108986 (sync LVI tests) - rust-lang#109142 (Add block-based mutex unlocking example) - rust-lang#109368 (fix typo in the creation of OpenOption for RustyHermit) - rust-lang#109493 (Return nested obligations from canonical response var unification) - rust-lang#109515 (Add AixLinker to support linking on AIX) - rust-lang#109536 (resolve: Rename some cstore methods to match queries and add comments) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
This makes sense, since the search index has the information in it, and it's more useful for function signature searches since a function signature search's item type is, by definition, some type of function (there's more than one, but not very many).