docs(allocator/address): improve docs for Address::from_ptr

[overlookmotel]

Improve the docs for Address::from_ptr to highlight why it's best avoided.

This was prompted by me noticing that Rolldown uses Address::from_ptr (rolldown/rolldown#6245).

[overlookmotel]

• feat(ast): implement GetAddress for ModuleDeclarationKind and PropertyKeyKind #15313
• perf(allocator/address): add #[repr(transparent)] to Address #15312
• docs(allocator/address): improve docs for Address::from_ptr #15311 👈 (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.

[Copilot]

Pull Request Overview

This PR enhances the documentation for the Address::from_ptr method by clarifying its usage and potential pitfalls. The update emphasizes that this method should be used as an escape hatch, with preference given to GetAddress::address for more stable address retrieval.

Key Changes:

• Reorganized and expanded documentation to highlight best practices
• Added comprehensive example demonstrating the difference between Address::from_ptr and GetAddress::address
• Clarified behavior when AST nodes are stored in Vec vs Box

---

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

[codspeed-hq]

CodSpeed Performance Report

Merging #15311 will not alter performance

_{Comparing 09-17-docs_allocator_address_improve_docs_for_address_from_ptr_ (f2b6b90) with main (798216b)¹}

Summary

✅ 37 untouched

Footnotes

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

[graphite-app]

Merge activity

• Nov 5, 11:17 AM UTC: overlookmotel added this pull request to the Graphite merge queue.
• Nov 5, 11:38 AM UTC: Merged by the Graphite merge queue.