docs(allocator): improve docs for `Address` methods #15697

overlookmotel · 2025-11-14T12:08:41Z

Improve docs for Address::from_ptr and Address::from_ref. Notably, include a warning about double-references in docs for Address::from_ptr.

overlookmotel · 2025-11-14T12:08:56Z

docs(allocator): improve docs for Address methods #15697 👈 (View in Graphite)
main

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 · 2025-11-14T12:10:44Z

Merge activity

Nov 14, 12:10 PM UTC: The merge label '0-merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
Nov 14, 12:23 PM UTC: overlookmotel added this pull request to the Graphite merge queue.
Nov 14, 12:29 PM UTC: Merged by the Graphite merge queue.

Copilot

Pull Request Overview

This PR improves the documentation for Address::from_ptr and Address::from_ref methods by converting plain text references to proper Rust documentation links and adding a warning about double-references to the from_ptr documentation.

Converts plain text references to markdown links for better navigation (GetAddress::address, Address, Box, Vec)
Adds warning and code example about double-references to from_ptr documentation (copied from from_ref)
Adds doc link references for Box and Vec pointing to crate::Box and crate::Vec

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

crates/oxc_allocator/src/address.rs

codspeed-hq · 2025-11-14T12:13:57Z

CodSpeed Performance Report

Merging #15697 will not alter performance

_{Comparing 11-14-docs_allocator_improve_docs_for_address_methods (55743dc) with main (e50a9bf)¹}

Summary

✅ 37 untouched

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

Improve docs for `Address::from_ptr` and `Address::from_ref`. Notably, include a warning about double-references in docs for `Address::from_ptr`.

### 💥 BREAKING CHANGES - ea51b0b napi: [**BREAKING**] Standardize function naming with sync suffixes (#15661) (Boshen) ### 🚀 Features - 77efb76 parser: Improve error message for invalid switch clauses (#15728) (sapphi-red) - 5691727 parser: Improve `import source` `from` error message (#15727) (sapphi-red) - b7404bc parser: Improve error message for missing function body (#15726) (sapphi-red) - 71c2fb0 parser: Improve error message when JSX is found while not enabled (#15725) (sapphi-red) - 56e7e44 minifier: Disable removal of unnecessary `use strict` directives for DCE (#15691) (sapphi-red) - 8a61cfd allocator, ast: Introduce `UnstableAddress` trait (#15700) (overlookmotel) - f5ce55a napi: Export all options using wildcard exports (Boshen) - 68703b9 minifier: Rotate binary expressions to remove parentheses (#15473) (sapphi-red) ### 🐛 Bug Fixes - c023ba6 semantic: Do not duplicate statements in temp `Vec` when binding `TSModuleDeclaration`s (#15724) (overlookmotel) - d60ca81 parser: Reject `import something 'source'` (#15746) (sapphi-red) - e0728fa ast: Exclude comment end position from `is_inside_comment` check (#15753) (camc314) - 9f54a36 semantic: Error on `\00` in strict mode (#15743) (sapphi-red) - 440a977 ast: Include rest properties when using `get_binding_identifiers` (#15710) (camc314) ### ⚡ Performance - 1f09d3c parser: Faster checking for invalid modifiers (#15717) (overlookmotel) - d8d4e31 ast: Use loop instead of recursion in `TSModuleDeclarationBody::as_module_block_mut` (#15713) (overlookmotel) ### 📚 Documentation - e033d50 ast: Clarify behavior of `TSModuleDeclaration::has_use_strict_directive` (#15730) (overlookmotel) - 9eda70f allocator: Improve docs for `Address` methods (#15697) (overlookmotel)

### 💥 BREAKING CHANGES - ea51b0b napi: [**BREAKING**] Standardize function naming with sync suffixes (oxc-project#15661) (Boshen) ### 🚀 Features - 77efb76 parser: Improve error message for invalid switch clauses (oxc-project#15728) (sapphi-red) - 5691727 parser: Improve `import source` `from` error message (oxc-project#15727) (sapphi-red) - b7404bc parser: Improve error message for missing function body (oxc-project#15726) (sapphi-red) - 71c2fb0 parser: Improve error message when JSX is found while not enabled (oxc-project#15725) (sapphi-red) - 56e7e44 minifier: Disable removal of unnecessary `use strict` directives for DCE (oxc-project#15691) (sapphi-red) - 8a61cfd allocator, ast: Introduce `UnstableAddress` trait (oxc-project#15700) (overlookmotel) - f5ce55a napi: Export all options using wildcard exports (Boshen) - 68703b9 minifier: Rotate binary expressions to remove parentheses (oxc-project#15473) (sapphi-red) ### 🐛 Bug Fixes - c023ba6 semantic: Do not duplicate statements in temp `Vec` when binding `TSModuleDeclaration`s (oxc-project#15724) (overlookmotel) - d60ca81 parser: Reject `import something 'source'` (oxc-project#15746) (sapphi-red) - e0728fa ast: Exclude comment end position from `is_inside_comment` check (oxc-project#15753) (camc314) - 9f54a36 semantic: Error on `\00` in strict mode (oxc-project#15743) (sapphi-red) - 440a977 ast: Include rest properties when using `get_binding_identifiers` (oxc-project#15710) (camc314) ### ⚡ Performance - 1f09d3c parser: Faster checking for invalid modifiers (oxc-project#15717) (overlookmotel) - d8d4e31 ast: Use loop instead of recursion in `TSModuleDeclarationBody::as_module_block_mut` (oxc-project#15713) (overlookmotel) ### 📚 Documentation - e033d50 ast: Clarify behavior of `TSModuleDeclaration::has_use_strict_directive` (oxc-project#15730) (overlookmotel) - 9eda70f allocator: Improve docs for `Address` methods (oxc-project#15697) (overlookmotel)

github-actions bot added the C-docs Category - Documentation. Related to user-facing or internal documentation label Nov 14, 2025

overlookmotel marked this pull request as ready for review November 14, 2025 12:09

Copilot AI review requested due to automatic review settings November 14, 2025 12:09

Copilot started reviewing on behalf of overlookmotel November 14, 2025 12:10 View session

overlookmotel self-assigned this Nov 14, 2025

overlookmotel added the 0-merge Merge with Graphite Merge Queue label Nov 14, 2025

Copilot finished reviewing on behalf of overlookmotel November 14, 2025 12:11

Copilot AI reviewed Nov 14, 2025

View reviewed changes

crates/oxc_allocator/src/address.rs Outdated Show resolved Hide resolved

overlookmotel marked this pull request as draft November 14, 2025 12:14

overlookmotel force-pushed the 11-14-docs_allocator_improve_docs_for_address_methods branch from 55743dc to 947ca9a Compare November 14, 2025 12:16

overlookmotel marked this pull request as ready for review November 14, 2025 12:16

docs(allocator): improve docs for Address methods (#15697)

9eda70f

Improve docs for `Address::from_ptr` and `Address::from_ref`. Notably, include a warning about double-references in docs for `Address::from_ptr`.

graphite-app bot force-pushed the 11-14-docs_allocator_improve_docs_for_address_methods branch from 947ca9a to 9eda70f Compare November 14, 2025 12:24

graphite-app bot merged commit 9eda70f into main Nov 14, 2025
21 checks passed

graphite-app bot deleted the 11-14-docs_allocator_improve_docs_for_address_methods branch November 14, 2025 12:29

graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Nov 14, 2025

Boshen mentioned this pull request Nov 17, 2025

release(crates): oxc v0.98.0 #15771

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs(allocator): improve docs for `Address` methods #15697

docs(allocator): improve docs for `Address` methods #15697

Uh oh!

overlookmotel commented Nov 14, 2025 •

edited

Loading

Uh oh!

overlookmotel commented Nov 14, 2025

Uh oh!

overlookmotel commented Nov 14, 2025 •

edited by graphite-app bot

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

codspeed-hq bot commented Nov 14, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

docs(allocator): improve docs for Address methods #15697

docs(allocator): improve docs for Address methods #15697

Uh oh!

Conversation

overlookmotel commented Nov 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

overlookmotel commented Nov 14, 2025

How to use the Graphite Merge Queue

Uh oh!

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

Uh oh!

Merge activity

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 Nov 14, 2025

CodSpeed Performance Report

Merging #15697 will not alter performance

Summary

Footnotes

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

docs(allocator): improve docs for `Address` methods #15697

docs(allocator): improve docs for `Address` methods #15697

overlookmotel commented Nov 14, 2025 •

edited

Loading

overlookmotel commented Nov 14, 2025 •

edited by graphite-app bot

Loading