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

rustdoc: add doc comment to DocVisitor #130537

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

rustdoc: add doc comment to DocVisitor #130537

wants to merge 1 commit into from
+7 −0

Conversation

lolbinarycat
Copy link

No description provided.

@rustbot
Copy link
Collaborator

rustbot commented Sep 18, 2024

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @GuillaumeGomez (or someone else) some time within the next two weeks.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

  • @rustbot author: the review is finished, PR author should check the comments and take action accordingly
  • @rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Sep 18, 2024
jieyouxu
jieyouxu reviewed Sep 19, 2024
View reviewed changes
src/librustdoc/visit.rs
@@ -1,5 +1,11 @@
use crate::clean::*;

/// allows a type to traverse the cleaned as of a crate.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit:

Suggested change
/// allows a type to traverse the cleaned as of a crate.
/// Allows a type to traverse the cleaned AST of a crate.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you want me to capitalize this sentence specifically? and not any of the other doc comments?

i was just matching the style of the existing comments.

Copy link
Member

@jieyouxu jieyouxu Sep 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry ignore the capitalization if it's pre-existing, just the as -> AST

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will do!

@lolbinarycat lolbinarycat 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-review Status: Awaiting review from the assignee but also interested parties. labels Sep 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jieyouxu jieyouxu jieyouxu left review comments

Assignees

@GuillaumeGomez GuillaumeGomez

Labels
S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. 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 this pull request may close these issues.
4 participants
@lolbinarycat @rustbot @jieyouxu @GuillaumeGomez