Skip to content
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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add code comments into src/librustdoc/html/render/cache.rs #90766

Closed
GuillaumeGomez opened this issue Nov 10, 2021 · 0 comments · Fixed by #90795
Closed

Add code comments into src/librustdoc/html/render/cache.rs #90766

GuillaumeGomez opened this issue Nov 10, 2021 · 0 comments · Fixed by #90795
Assignees
@GuillaumeGomez
Labels
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.

Comments

@GuillaumeGomez
Copy link
Member

The generation of the search index isn't easy to grasp so code comments would definitely improve the situation. It was started in #90727 but needs to be continued.
@GuillaumeGomez GuillaumeGomez added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Nov 10, 2021
@GuillaumeGomez GuillaumeGomez self-assigned this Nov 10, 2021
@GuillaumeGomez GuillaumeGomez mentioned this issue Nov 10, 2021
Merged
@camelid camelid added the C-cleanup Category: PRs that clean code up or issues documenting cleanup. label Nov 11, 2021
@GuillaumeGomez GuillaumeGomez mentioned this issue Nov 11, 2021
Merged
@bors bors closed this as completed in f522f26 Nov 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@GuillaumeGomez GuillaumeGomez

Labels
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.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add more comments to explain the code to generate the search index GuillaumeGomez/rust
2 participants
@GuillaumeGomez @camelid