Fix AST documentation formatting and remove pointless comments#12767
Closed
Fix AST documentation formatting and remove pointless comments#12767
Conversation
Contributor
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. |
Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Improve documentation of AST
Fix AST documentation formatting and remove pointless comments
Aug 2, 2025
This file contains hidden or 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
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.
This PR addresses two specific documentation issues in the
oxc_astcrate as outlined in the issue:Fixed Issue #5: Inconsistent formatting
Problem: Type names and references were inconsistently formatted in doc comments.
Solution: Standardized all type references to use proper Rust doc formatting:
[variable declarations](VariableDeclaration)→[VariableDeclaration]Empty Statement→EmptyStatementExamples of changes:
Fixed Issue #4: Pointless comments
Problem: Many doc comments contained redundant text that just repeated what the struct fields already showed.
Solution: Removed "includes..." patterns that added no value beyond the type definition itself:
Removed patterns:
All meaningful documentation (examples, syntax explanations, links to specs) was preserved. Only redundant field descriptions were removed.
Impact: 11 lines of pointless documentation removed, 27 lines improved for consistency. Documentation is now cleaner and more useful while maintaining all essential information.
Fixes #12728.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.