Skip to content

docs(allocator): upgrade headers in doc comments for Bump#21263

Merged
graphite-app[bot] merged 1 commit intomainfrom
om/04-09-docs_allocator_upgrade_headers_in_doc_comments_for_bump_
Apr 9, 2026
Merged

docs(allocator): upgrade headers in doc comments for Bump#21263
graphite-app[bot] merged 1 commit intomainfrom
om/04-09-docs_allocator_upgrade_headers_in_doc_comments_for_bump_

Conversation

@overlookmotel
Copy link
Copy Markdown
Member

@overlookmotel overlookmotel commented Apr 9, 2026

Doc comments only change. Our convention is to use largest header size in doc comments (/// # Whatever). Convert doc comments for Bump to follow that convention.

Copy link
Copy Markdown
Member Author

overlookmotel commented Apr 9, 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.

@github-actions github-actions Bot added A-allocator Area - Allocator C-docs Category - Documentation. Related to user-facing or internal documentation labels Apr 9, 2026
@overlookmotel overlookmotel self-assigned this Apr 9, 2026
@overlookmotel overlookmotel marked this pull request as ready for review April 9, 2026 14:39
Copilot AI review requested due to automatic review settings April 9, 2026 14:39
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

Updates rustdoc markdown heading levels in Bump’s doc comments to match the crate’s convention of using /// # ... as the largest header size.

Changes:

  • Promoted section headers like “Example”, “Panics”, and “Errors” from ## to # in Bump docs.
  • Adjusted nested subheaders accordingly (e.g., #####, #######) to preserve hierarchy.

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented Apr 9, 2026

Merging this PR will not alter performance

✅ 48 untouched benchmarks
⏩ 3 skipped benchmarks1


Comparing om/04-09-docs_allocator_upgrade_headers_in_doc_comments_for_bump_ (b924f40) with main (64cb025)

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.

@graphite-app graphite-app Bot changed the base branch from om/04-09-refactor_allocator_switch_to_non-deprecated_stdlib_error_types to graphite-base/21263 April 9, 2026 14:45
@graphite-app graphite-app Bot force-pushed the om/04-09-docs_allocator_upgrade_headers_in_doc_comments_for_bump_ branch from bd8fc11 to dead140 Compare April 9, 2026 15:00
@graphite-app graphite-app Bot force-pushed the graphite-base/21263 branch from dc157cb to 64cb025 Compare April 9, 2026 15:00
@graphite-app graphite-app Bot changed the base branch from graphite-base/21263 to main April 9, 2026 15:01
@graphite-app graphite-app Bot force-pushed the om/04-09-docs_allocator_upgrade_headers_in_doc_comments_for_bump_ branch from dead140 to b924f40 Compare April 9, 2026 15:01
@overlookmotel overlookmotel added the 0-merge Merge with Graphite Merge Queue label Apr 9, 2026
Copy link
Copy Markdown
Member Author

overlookmotel commented Apr 9, 2026

Merge activity

Doc comments only change. Our convention is to use largest header size in doc comments (`/// # Whatever`). Convert doc comments for `Bump` to follow that convention.
@graphite-app graphite-app Bot force-pushed the om/04-09-docs_allocator_upgrade_headers_in_doc_comments_for_bump_ branch from b924f40 to f5e1845 Compare April 9, 2026 16:02
@graphite-app graphite-app Bot merged commit f5e1845 into main Apr 9, 2026
27 checks passed
@graphite-app graphite-app Bot deleted the om/04-09-docs_allocator_upgrade_headers_in_doc_comments_for_bump_ branch April 9, 2026 16:06
@graphite-app graphite-app Bot removed the 0-merge Merge with Graphite Merge Queue label Apr 9, 2026
camc314 pushed a commit that referenced this pull request Apr 13, 2026
### 💥 BREAKING CHANGES

- 36cdc31 str: [**BREAKING**] Remove identity `FromIn` impl for `Ident`
(#21251) (overlookmotel)
- 382958a span: [**BREAKING**] Remove re-exports of string types from
`oxc_span` crate (#21246) (overlookmotel)
- c4aedfa str: [**BREAKING**] Add `static_ident!` macro (#21245)
(overlookmotel)

### 🚀 Features

- e7e1aea transformer/typescript: Add `optimize_enums` option for
regular enum inlining (#20539) (Dunqing)
- 679f57f transformer/typescript: Implement const enum inlining and
declaration removal (#20508) (Dunqing)
- 6dd061c semantic: Extend `MemberWriteTarget` to cover all property
modification patterns (#21205) (Dunqing)
- f134e24 minifier: Support `property_write_side_effects` option to drop
unused property assignments (#20773) (Dunqing)
- 75663c0 semantic: Add enum member value evaluation for const enum
support (#20602) (Dunqing)
- 3cfe8ed semantic: Add `MemberWriteTarget` flag to `ReferenceFlags`
(#20772) (Dunqing)

### 🐛 Bug Fixes

- af1a586 transformer/class-properties: Use correct property name when
converting parameter properties (#21268) (Amal Jossy)
- b43250a allocator: Move allocation tracking into `Bump` (#21342)
(overlookmotel)
- 36f505f allocator: `StringBuilder` use `Allocator::alloc_layout`
(#21340) (overlookmotel)
- 7a08a6f allocator: Fix allocation counting in
`Allocator::alloc_concat_strs_array` (#21336) (overlookmotel)
- 2338e28 ecmascript: Treat `this` as potentially having side effects
(#21297) (sapphi-red)
- bd8bd39 allocator: Remove unsafe hacks from `from_raw_parts` methods
(#21283) (overlookmotel)
- 8f4c340 allocator: Remove dangerous pointer const to mut cast (#21279)
(overlookmotel)
- aa9259f parser: Add missing error code for optional param diagnostic
(#21258) (camc314)
- 04b3c2f str: Fix unsound casting const pointers to mut pointers
(#21242) (overlookmotel)
- ceadf6c str: Make `Ident::from_raw` an unsafe function (#21241)
(overlookmotel)
- eab13b3 transformer/decorators: Avoid accessor storage name collisions
(#21106) (Dunqing)
- 07e8a30 transformer/react-refresh: Handle parenthesized variable
initializers (#21047) (camc314)

### ⚡ Performance

- c3ca6f6 allocator: `StringBuilder::from_strs_array_in` check for 0
length earlier (#21338) (overlookmotel)
- c2422bb allocator: `Allocator::alloc_concat_strs_array` check for 0
length earlier (#21337) (overlookmotel)
- 04b0fdc allocator: Mark `Allocator::alloc_layout` as
`#[inline(always)]` (#21335) (overlookmotel)
- 17aee9e allocator: Use `offset_from_unsigned` in
`ChunkFooter::as_raw_parts` (#21280) (overlookmotel)
- 61adedd minifier: Fix O(n²) perf on very many var decls (#21062)
(Gunnlaugur Thor Briem)
- addcd02 napi/parser, linter/plugins: Raw transfer deserializer for
`Vec`s use shift instead of multiply where possible (#21142)
(overlookmotel)
- 3068ded napi/parser, linter/plugins: Shift before add when calculating
positions in raw transfer deserializer (#21141) (overlookmotel)
- eb400b8 napi/parser, linter/plugins: Remove `uint32` buffer view
(#21140) (overlookmotel)
- 2675085 napi/parser: Lazy deserialization use only `Int32Array`
(#21139) (overlookmotel)
- 5b35a53 napi/parser: Deserializing tokens use only `int32` array
(#21138) (overlookmotel)
- f163d10 parser: Tokens raw deserialization use `Int32Array` (#21137)
(overlookmotel)
- 7a86613 linter/plugins: Use `Int32Array`s for tokens and comments
buffers (#21136) (overlookmotel)
- 8c51121 napi/parser, linter/plugins: Raw transfer deserialize `Span`
fields as `i32`s (#21135) (overlookmotel)
- bc1bcdd napi/parser, linter/plugins: Inline trivial raw transfer field
deserializers into node object definitions (#21134) (overlookmotel)
- c0278ab napi/parser, linter/plugins: Use `Int32Array` in raw transfer
deserializer (#21132) (overlookmotel)
- 43482c7 linter/plugins: Use `>>` not `>>>` in binary search loops
(#21129) (overlookmotel)

### 📚 Documentation

- f5e1845 allocator: Upgrade headers in doc comments for `Bump` (#21263)
(overlookmotel)
- 2870174 allocator: Upper case `SAFETY` in comments (#21253)
(overlookmotel)
- 01bc269 str: Reformat `Ident` doc comments (#21240) (overlookmotel)
- dd47359 allocator: Add doc comments for panics and errors (#21230)
(overlookmotel)
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