Skip to content

docs(allocator): correct typos in comments#22092

Merged
graphite-app[bot] merged 1 commit intomainfrom
om/05-03-docs_allocator_correct_typos_in_comments
May 3, 2026
Merged

docs(allocator): correct typos in comments#22092
graphite-app[bot] merged 1 commit intomainfrom
om/05-03-docs_allocator_correct_typos_in_comments

Conversation

@overlookmotel
Copy link
Copy Markdown
Member

@overlookmotel overlookmotel commented May 3, 2026

Comments-only change. Just correct typos in 2 comments.

Copy link
Copy Markdown
Member Author

overlookmotel commented May 3, 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.

@overlookmotel overlookmotel self-assigned this May 3, 2026
@overlookmotel overlookmotel marked this pull request as ready for review May 3, 2026 09:32
Copilot AI review requested due to automatic review settings May 3, 2026 09:32
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 makes a comments-only documentation fix in the allocator arena drop/deallocation logic by correcting phrasing in two safety-related inline comments.

Changes:

  • Fixes wording in the dealloc_chunk_list comment explaining why a &ChunkFooter reference is scoped to a block.
  • Fixes the same wording in the dealloc_arena_chunk comment for consistency.

@overlookmotel overlookmotel added A-allocator Area - Allocator C-docs Category - Documentation. Related to user-facing or internal documentation labels May 3, 2026
@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented May 3, 2026

Merging this PR will not alter performance

✅ 48 untouched benchmarks
⏩ 3 skipped benchmarks1


Comparing om/05-03-docs_allocator_correct_typos_in_comments (3e152c6) with main (0bf0cb9)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 main (3e152c6) during the generation of this report, so 0bf0cb9 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

@graphite-app
Copy link
Copy Markdown
Contributor

graphite-app Bot commented May 3, 2026

Merge activity

Comments-only change. Just correct typos in 2 comments.
@graphite-app graphite-app Bot force-pushed the om/05-03-docs_allocator_correct_typos_in_comments branch from fe3d952 to 3e152c6 Compare May 3, 2026 09:59
@graphite-app graphite-app Bot merged commit 3e152c6 into main May 3, 2026
36 checks passed
@graphite-app graphite-app Bot deleted the om/05-03-docs_allocator_correct_typos_in_comments branch May 3, 2026 10:03
camc314 added a commit that referenced this pull request May 5, 2026
### 💥 BREAKING CHANGES

- 0ffbe0d allocator: [**BREAKING**] Remove `Allocator::end_ptr` method
(#21871) (overlookmotel)

### 🚀 Features

- 9593ec8 transformer/jsx: Add jsxDEV source metadata for fragments
(#21932) (Ido Rosenthal)

### 🐛 Bug Fixes

- 429deac napi/parser: Export `visitorKeys` from `wasm` entrypoint
(#21996) (NullVoxPopuli)
- e852911 codegen: Preserve legal comments orphaned by upstream passes
(#21575) (Dunqing)
- e3399ec transformer/class-properties: Preserve RHS in
logical-assignment to static private field (#21950) (Dunqing)
- c59c199 transformer/typescript: Emit class fields for parameter
properties (#21831) (Dunqing)
- aaabde4 parser: Attach legal comments to following token (#21670)
(Dunqing)

### ⚡ Performance

- 0bf0cb9 allocator: Per-platform `Arena::new_fixed_size`
implementations (#22088) (overlookmotel)

### 📚 Documentation

- 62ec410 allocator: Correct doc comment for `Allocator::from_raw_parts`
(#22093) (overlookmotel)
- 3e152c6 allocator: Correct typos in comments (#22092) (overlookmotel)
- e220855 allocator: Correct doc comment for `Allocator::set_cursor_ptr`
(#21866) (overlookmotel)

---------

Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
Co-authored-by: Cameron Clark <cameron.clark@hey.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