-
-
Notifications
You must be signed in to change notification settings - Fork 722
docs(allocator): document all cargo features #13104
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
docs(allocator): document all cargo features #13104
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. This stack of pull requests is managed by Graphite. Learn more about stacking. |
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 updates documentation to ensure consistency between the README and library documentation by documenting all cargo features for the oxc_allocator crate. The changes synchronize feature documentation that was previously out of sync and incomplete.
- Added missing cargo feature documentation in both README.md and lib.rs
- Updated existing feature descriptions for clarity and consistency
- Ensured both documentation sources contain the same comprehensive feature list
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| crates/oxc_allocator/src/lib.rs | Added documentation for track_allocations and disable_track_allocations features |
| crates/oxc_allocator/README.md | Updated and expanded feature list to include all cargo features with consistent descriptions |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
Docs-only change, and I think uncontroversial, so merging without review. |
Merge activity
|
CodSpeed Instrumentation Performance ReportMerging #13104 will not alter performanceComparing Summary
Footnotes |
`README` and doc comment in `lib.rs` were out of sync and both missed out some of `oxc_allocator`'s cargo features. Document all the features in both places.
a35c1e2 to
3048302
Compare

READMEand doc comment inlib.rswere out of sync and both missed out some ofoxc_allocator's cargo features. Document all the features in both places.