Skip to content

docs(allocator, data_structures): correct comments#20966

Merged
graphite-app[bot] merged 1 commit intomainfrom
om/04-02-docs_allocator_data_structures_correct_comments
Apr 2, 2026
Merged

docs(allocator, data_structures): correct comments#20966
graphite-app[bot] merged 1 commit intomainfrom
om/04-02-docs_allocator_data_structures_correct_comments

Conversation

@overlookmotel
Copy link
Copy Markdown
Member

@overlookmotel overlookmotel commented Apr 2, 2026

Follow on after #18172.

That PR made changes to comments to remove references to bumpalo from the codebase. Correct a few of those comments which were incorrect.

Copy link
Copy Markdown
Member Author

overlookmotel commented Apr 2, 2026


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 changes, fast-track this PR to the front of 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.

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq bot commented Apr 2, 2026

Merging this PR will not alter performance

✅ 48 untouched benchmarks
⏩ 3 skipped benchmarks1


Comparing om/04-02-docs_allocator_data_structures_correct_comments (ddd06ac) with om/04-02-refactor_allocator_remove_unnecessary_pub_crate_from_mod_statement (b6fe07c)2

Open in CodSpeed

Footnotes

  1. 3 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

  2. No successful run was found on om/04-02-refactor_allocator_remove_unnecessary_pub_crate_from_mod_statement (e76edb0) during the generation of this report, so e125034 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

@overlookmotel overlookmotel marked this pull request as ready for review April 2, 2026 13:44
Copilot AI review requested due to automatic review settings April 2, 2026 13:44
Copy link
Copy Markdown
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 follows up on #18172 by adjusting a few allocator/data-structure doc comments that were made inaccurate during the “remove bumpalo references” cleanup.

Changes:

  • Updates NonEmptyStack design docs to mention a downward-growing stack alternative.
  • Clarifies allocator chunk minimum alignment in from_raw_parts.
  • Tweaks Allocator inline rationale comments to describe delegation to Bump.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.

File Description
crates/oxc_data_structures/src/stack/non_empty.rs Updates design commentary for an alternative stack growth strategy.
crates/oxc_allocator/src/from_raw_parts.rs Clarifies the minimum chunk alignment constant’s relationship to allocator internals.
crates/oxc_allocator/src/allocator.rs Adjusts inline(always) justification comments for wrapper methods.

@overlookmotel overlookmotel force-pushed the om/04-02-refactor_allocator_remove_unnecessary_pub_crate_from_mod_statement branch from b6fe07c to e76edb0 Compare April 2, 2026 14:55
@overlookmotel overlookmotel force-pushed the om/04-02-docs_allocator_data_structures_correct_comments branch from 3e04edd to ddd06ac Compare April 2, 2026 14:55
@overlookmotel overlookmotel self-assigned this Apr 2, 2026
@overlookmotel overlookmotel added the A-allocator Area - Allocator label Apr 2, 2026
@overlookmotel overlookmotel added the 0-merge Merge with Graphite Merge Queue label Apr 2, 2026 — with Graphite App
@graphite-app
Copy link
Copy Markdown
Contributor

graphite-app bot commented Apr 2, 2026

Merge activity

Follow on after #18172.

That PR made changes to comments to remove references to `bumpalo` from the codebase. Correct a few of those comments which were incorrect.
@graphite-app graphite-app bot force-pushed the om/04-02-refactor_allocator_remove_unnecessary_pub_crate_from_mod_statement branch from e76edb0 to 4c37a7a Compare April 2, 2026 15:10
@graphite-app graphite-app bot force-pushed the om/04-02-docs_allocator_data_structures_correct_comments branch from ddd06ac to b1da750 Compare April 2, 2026 15:11
@graphite-app graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Apr 2, 2026
Base automatically changed from om/04-02-refactor_allocator_remove_unnecessary_pub_crate_from_mod_statement to main April 2, 2026 15:16
@graphite-app graphite-app bot merged commit b1da750 into main Apr 2, 2026
28 checks passed
@graphite-app graphite-app bot deleted the om/04-02-docs_allocator_data_structures_correct_comments branch April 2, 2026 15:17
leaysgur pushed a commit that referenced this pull request Apr 7, 2026
### 🐛 Bug Fixes

- fc7f60c allocator: Revert changes to
`get_current_chunk_footer_field_offset` (#20964) (overlookmotel)
- 31316c8 semantic: Rebind class expressions before identifier checks
(#20916) (camc314)

### ⚡ Performance

- fb52383 napi/parser, linter/plugins: Clear buffers and source texts
earlier (#21025) (overlookmotel)
- 3b7dec4 napi/parser, linter/plugins: Use `utf8Slice` for decoding
UTF-8 strings (#21022) (overlookmotel)
- 012c924 napi/parser, linter/plugins: Speed up decoding strings in raw
transfer (#21021) (overlookmotel)
- 55e1e9b napi/parser, linter/plugins: Initialize vars as 0 (#21020)
(overlookmotel)
- c25ef02 napi/parser, linter/plugins: Simplify branch condition in
`deserializeStr` (#21019) (overlookmotel)
- 9f494c3 napi/parser, linter/plugins: Raw transfer use
`String.fromCharCode` in string decoding (#21018) (overlookmotel)
- 91cf105 allocator: Increase initial chunk size from 512B to 16KB
(#20968) (overlookmotel)
- cbc0c21 allocator: Add `#[cold]` to to error handling functions
(#20967) (overlookmotel)
- 0503a78 napi/parser, linter/plugins: Faster deserialization of `raw`
fields (#20923) (overlookmotel)
- a24f75e napi/parser: Optimize string deserialization for non-ASCII
sources (#20834) (Joshua Tuddenham)

### 📚 Documentation

- c78a57a syntax: Fix typo (#21044) (camc314)
- f5e228f allocator: Fix typo in comment (#20972) (overlookmotel)
- 7159d51 allocator: Improve doc comment examples for `vec2::Vec`
(#20969) (overlookmotel)
- b1da750 allocator, data_structures: Correct comments (#20966)
(overlookmotel)

Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-allocator Area - Allocator 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