docs(traverse): update safety comments#16944
Merged
graphite-app[bot] merged 1 commit intomainfrom Dec 16, 2025
Merged
Conversation
github-actions
bot
added
the
C-docs
Member
Author
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. This stack of pull requests is managed by Graphite. Learn more about stacking. |
Member
Author
Merge activity
|
1 task
CodSpeed Performance ReportMerging #16944 will not alter performanceComparing Summary
Footnotes
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates safety documentation comments in the traverse module following changes from PR #16758. The changes standardize safety comment formatting by converting /// # Safety to /// # SAFETY in doc comments and // INVARIANTS: to // SAFETY in inline comments.
Key Changes:
- Standardize doc comment safety headers to use
/// # SAFETY(all caps) - Replace
// INVARIANTS:inline comment with// SAFETY - Update both generated files and their generator scripts for consistency
Reviewed changes
Copilot reviewed 2 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
crates/oxc_traverse/src/generated/walk.rs |
Changed doc comment from /// # Safety to /// # SAFETY for walk_program function |
crates/oxc_traverse/src/generated/ancestor.rs |
Changed inline comment from // INVARIANTS: to // SAFETY for Ancestor enum |
crates/oxc_traverse/scripts/lib/walk.mjs |
Updated generator script to produce /// # SAFETY in generated code |
crates/oxc_traverse/scripts/lib/ancestor.mjs |
Updated generator script to produce // SAFETY in generated code |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Follow-on after #16758. Update "SAFETY" docs comments which were altered in that PR to make clippy pass.
graphite-app
bot
force-pushed
the
12-16-docs_traverse_update_safety_comments
branch
from
4a0647c to
a9c419f
Compare
graphite-app
bot
deleted the
12-16-docs_traverse_update_safety_comments
branch
overlookmotel
added a commit
that referenced
this pull request
Dec 19, 2025
### 🚀 Features - d209c21 allocator: Add cap to FixedSizeAllocatorPool and block when exhausted (#17023) (Cameron) - fb2af91 allocator: Add bitset utils (#17042) (zhaoting zhou) - c16082c tasks/compat_data: Integrate `node-compat-table` (#16831) (Boshen) - 5586823 span: Extract TS declaration file check to its own function (#17037) (camchenry) - 3d2b492 minifier: Fold iife arrow functions in call expressions (#16477) (Armano) - 67e9f9e codegen: Keep comments on the export specifiers (#16943) (夕舞八弦) - cb515fa parser: Improve error message for `yield` as identifier usage (#16950) (sapphi-red) - dcc856b parser: Add help for `new_dynamic_import` error (#16949) (sapphi-red) - c3c79f8 parser: Improve import attribute value error message (#16948) (sapphi-red) - 291b57b ast_tools: Generate TS declaration files for deserializer and walk files (#16912) (camc314) - 74eae13 minifier: Remove unused import specifiers (#16797) (camc314) ### 🐛 Bug Fixes - fb9e193 linter: OOM problems with custom plugins (#17082) (overlookmotel) - e59132b parser/napi: Fix lazy deser (#17069) (overlookmotel) - a92faf0 ast_tools: Support `u128` in `assert_layouts` generator (#17050) (overlookmotel) - 47b4c2f minifier/docs: Correct hyperlink path in OPTIMIZATIONS.md (#16986) (GRK) - 3002649 transformer/typescript: Remove unused import equals declaration (#16776) (Dunqing) - 5a2af88 regular_expression: Correct named capture group reference error (#16952) (sapphi-red) ### ⚡ Performance - b657bb6 allocator: Reduce time `Mutex` lock is held in `FixedSizeAllocatorPool::get` (#17079) (overlookmotel) - 1f3b19b ast: `#[ast]` macro use `#[repr(transparent)]` for single-field structs (#17052) (overlookmotel) - 225f229 parser: Use SmallVec for duplicate default export detection (#16801) (camc314) ### 📚 Documentation - a9c419f traverse: Update safety comments (#16944) (overlookmotel) Co-authored-by: overlookmotel <[email protected]>
qinyuhang
pushed a commit
to qinyuhang/oxc
that referenced
this pull request
Jan 22, 2026
Follow-on after oxc-project#16758. Update "SAFETY" docs comments which were altered in that PR to make clippy pass.
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
2 participants
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.
Follow-on after #16758. Update "SAFETY" docs comments which were altered in that PR to make clippy pass.