Add more comments to explain the code to generate the search index #90795
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
the
T-rustdoc
notriddle
reviewed
Nov 11, 2021
src/librustdoc/html/render/cache.rs
Outdated
| @@ -360,6 +366,7 @@ crate fn get_real_types<'tcx>( | |||
| insert_ty(res, tcx, arg.clone(), ty_generics); | |||
| } | |||
| } else { | |||
| // This is not a type parameter so we can add it directly (and look for its trait bounds). | |||
There was a problem hiding this comment.
Do things that aren’t type parameters have trait bounds, or are we talking about its own nested type parameters.
There was a problem hiding this comment.
Oh damn, I was talking about its own nested type parameters. Good catch! I'll try to extend the comment to make it more explicit too while I'm at it.
GuillaumeGomez
force-pushed
the
more-search-index-comments
branch
from
a3aedda
to
9c05335
Compare
|
I extended the comment and tried to make it more clear. Please tell me if it's too much or still unclear. |
notriddle
approved these changes
Nov 12, 2021
|
@bors: r=notriddle rollup |
|
📌 Commit 9c05335 has been approved by |
bors
added
the
S-waiting-on-bors
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Nov 12, 2021
…askrgr Rollup of 7 pull requests Successful merges: - rust-lang#90589 (rustc_llvm: update PassWrapper for recent LLVM) - rust-lang#90644 (Extend the const swap feature) - rust-lang#90704 (Unix ExitStatus comments and a tiny docs fix) - rust-lang#90761 (Shorten Span of unused macro lints) - rust-lang#90795 (Add more comments to explain the code to generate the search index) - rust-lang#90798 (Document `unreachable!` custom panic message) - rust-lang#90826 (rustc_feature: Convert `BuiltinAttribute` from tuple to a struct) 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.
Fixes #90766.
I tried to put comments when the code wasn't easy to understand at first sight and added more documentation on the recursive function. Please tell me if I misused the terminology or if comments can be improved or added into other places.
r? @notriddle