docs(allocator): add doc comments for panics and errors by overlookmotel · Pull Request #21230 · oxc-project/oxc

overlookmotel · 2026-04-09T09:46:45Z

Add # Errors and # Panics sections to doc comments for all methods which can panic or return Result::Err.

overlookmotel · 2026-04-09T09:47:14Z

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.

Copilot

Pull request overview

Updates oxc_allocator’s bump allocator API docs to explicitly document fallible behavior, aligning with Clippy’s missing_errors_doc / missing_panics_doc expectations.

Changes:

Removed module-level clippy::missing_errors_doc / clippy::missing_panics_doc expectations in favor of per-method documentation.
Added # Errors and # Panics sections to relevant Bump constructors and allocation helpers.
Added a targeted #[expect(clippy::missing_errors_doc)] on try_new() with rationale since it is effectively infallible.

crates/oxc_allocator/src/bump.rs

codspeed-hq · 2026-04-09T09:53:47Z

Merging this PR will not alter performance

✅ 48 untouched benchmarks
⏩ 3 skipped benchmarks¹

_{Comparing om/04-08-docs_allocator_add_doc_comments_for_panics_and_errors (0add906) with main (145930f)²}

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. ↩
No successful run was found on om/04-08-refactor_allocator_fix_unnecessary_safety_comment_clippy_warnings (2571918) during the generation of this report, so main (145930f) was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

overlookmotel · 2026-04-09T10:03:23Z

Merge activity

Apr 9, 10:03 AM UTC: The merge label '0-merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
Apr 9, 10:03 AM UTC: overlookmotel added this pull request to the Graphite merge queue.
Apr 9, 10:14 AM UTC: Merged by the Graphite merge queue.

Add `# Errors` and `# Panics` sections to doc comments for all methods which can panic or return `Result::Err`.

### 💥 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)

github-actions bot added the A-allocator Area - Allocator label Apr 9, 2026

overlookmotel mentioned this pull request Apr 9, 2026

refactor(allocator): fix ptr_cast_constness clippy warnings #21222

Merged

github-actions bot added the C-docs Category - Documentation. Related to user-facing or internal documentation label Apr 9, 2026

This was referenced Apr 9, 2026

refactor(allocator): fix cast_ptr_alignment clippy warnings #21223

Merged

refactor(allocator): fix cast_sign_loss clippy warnings #21224

Merged

refactor(allocator): fix mut_from_ref clippy warnings #21225

Merged

This was referenced Apr 9, 2026

refactor(allocator): fix unsafe_op_in_unsafe_fn clippy warnings #21228

Merged

refactor(allocator): fix unnecessary_safety_comment clippy warnings #21229

Merged

overlookmotel marked this pull request as ready for review April 9, 2026 09:48

Copilot AI review requested due to automatic review settings April 9, 2026 09:48

Copilot started reviewing on behalf of overlookmotel April 9, 2026 09:48 View session

overlookmotel self-assigned this Apr 9, 2026

Copilot AI reviewed Apr 9, 2026

View reviewed changes

crates/oxc_allocator/src/bump.rs Show resolved Hide resolved

overlookmotel added 0-merge Merge with Graphite Merge Queue labels Apr 9, 2026

docs(allocator): add doc comments for panics and errors (#21230)

dd47359

Add `# Errors` and `# Panics` sections to doc comments for all methods which can panic or return `Result::Err`.

graphite-app bot force-pushed the om/04-08-refactor_allocator_fix_unnecessary_safety_comment_clippy_warnings branch from 2571918 to 2dfb7c7 Compare April 9, 2026 10:06

graphite-app bot force-pushed the om/04-08-docs_allocator_add_doc_comments_for_panics_and_errors branch from 0add906 to dd47359 Compare April 9, 2026 10:06

graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Apr 9, 2026

Base automatically changed from om/04-08-refactor_allocator_fix_unnecessary_safety_comment_clippy_warnings to main April 9, 2026 10:13

graphite-app bot merged commit dd47359 into main Apr 9, 2026
28 checks passed

graphite-app bot deleted the om/04-08-docs_allocator_add_doc_comments_for_panics_and_errors branch April 9, 2026 10:14

Boshen mentioned this pull request Apr 13, 2026

release(crates): oxc v0.125.0 #21374

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs(allocator): add doc comments for panics and errors#21230

docs(allocator): add doc comments for panics and errors#21230
graphite-app[bot] merged 1 commit intomainfrom
om/04-08-docs_allocator_add_doc_comments_for_panics_and_errors

overlookmotel commented Apr 9, 2026 •

edited

Loading

Uh oh!

overlookmotel commented Apr 9, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

codspeed-hq bot commented Apr 9, 2026

Uh oh!

overlookmotel commented Apr 9, 2026 •

edited by graphite-app bot

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

overlookmotel commented Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

overlookmotel commented Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

How to use the Graphite Merge Queue

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

codspeed-hq bot commented Apr 9, 2026

Merging this PR will not alter performance

Footnotes

Uh oh!

overlookmotel commented Apr 9, 2026 • edited by graphite-app bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge activity

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

overlookmotel commented Apr 9, 2026 •

edited

Loading

overlookmotel commented Apr 9, 2026 •

edited

Loading

overlookmotel commented Apr 9, 2026 •

edited by graphite-app bot

Loading