Skip to content

Conversation

@overlookmotel
Copy link
Member

@overlookmotel overlookmotel commented Aug 14, 2025

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.

@github-actions github-actions bot added the C-docs Category - Documentation. Related to user-facing or internal documentation label Aug 14, 2025
Copy link
Member Author


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • 0-merge - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

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.

@overlookmotel overlookmotel marked this pull request as ready for review August 14, 2025 20:48
Copilot AI review requested due to automatic review settings August 14, 2025 20:48
Copy link
Contributor

Copilot AI left a 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.

@overlookmotel
Copy link
Member Author

Docs-only change, and I think uncontroversial, so merging without review.

@overlookmotel overlookmotel added the 0-merge Merge with Graphite Merge Queue label Aug 14, 2025
Copy link
Member Author

overlookmotel commented Aug 14, 2025

Merge activity

@codspeed-hq
Copy link

codspeed-hq bot commented Aug 14, 2025

CodSpeed Instrumentation Performance Report

Merging #13104 will not alter performance

Comparing 08-09-docs_allocator_document_all_cargo_features (3048302) with main (5783df2)1

Summary

✅ 34 untouched benchmarks

Footnotes

  1. No successful run was found on main (3048302) during the generation of this report, so 5783df2 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

`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.
@graphite-app graphite-app bot force-pushed the 08-09-docs_allocator_document_all_cargo_features branch from a35c1e2 to 3048302 Compare August 14, 2025 20:58
@graphite-app graphite-app bot merged commit 3048302 into main Aug 14, 2025
26 checks passed
@graphite-app graphite-app bot deleted the 08-09-docs_allocator_document_all_cargo_features branch August 14, 2025 21:04
@graphite-app graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Aug 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

C-docs Category - Documentation. Related to user-facing or internal documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants