-
-
Notifications
You must be signed in to change notification settings - Fork 726
fix(rust): fix missing docs #13541
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.
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
fix(rust): fix missing docs #13541
Conversation
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR fixes missing documentation in Rust code by adding comprehensive module-level and function-level documentation across several AST and codegen modules.
- Removes
#![expect(missing_docs)]attributes that were suppressing documentation warnings - Adds detailed module documentation explaining the purpose and functionality of each module
- Adds comprehensive function and type documentation with examples where appropriate
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| crates/oxc_codegen/src/context.rs | Added module docs and comprehensive documentation for Context type and its methods |
| crates/oxc_ast/src/trivia.rs | Added module docs and detailed function documentation for comment handling utilities |
| crates/oxc_ast/src/ast_kind_impl.rs | Added module docs and method documentation for AST node type checking and conversion utilities |
| crates/oxc_ast/src/ast/ts.rs | Added comprehensive module documentation for TypeScript AST definitions |
| crates/oxc_ast/src/ast/js.rs | Added comprehensive module documentation for JavaScript AST definitions |
| .claude/settings.local.json | Added tool permissions for ast-grep and rg commands |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
CodSpeed Instrumentation Performance ReportMerging #13541 will not alter performanceComparing Summary
Footnotes |
557f7e1 to
4e2b7ee
Compare
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
No description provided.