Skip to content

docs(allocator): improve doc comment examples for vec2::Vec#20969

Merged
graphite-app[bot] merged 1 commit intomainfrom
om/04-02-docs_allocator_improve_doc_comment_examples_for_vec2_vec_
Apr 2, 2026
Merged

docs(allocator): improve doc comment examples for vec2::Vec#20969
graphite-app[bot] merged 1 commit intomainfrom
om/04-02-docs_allocator_improve_doc_comment_examples_for_vec2_vec_

Conversation

@overlookmotel
Copy link
Copy Markdown
Member

@overlookmotel overlookmotel commented Apr 2, 2026

Follow-on after #18168.

With the removal of bumpalo dependency, the examples in doc comments in vec2::Vec would no longer compile. That PR marked them all as text to prevent them running as doctests. Change them to ignore instead. That's preferable as it at least makes sure they're valid Rust syntax.

Copy link
Copy Markdown
Member Author

overlookmotel commented Apr 2, 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 the C-docs Category - Documentation. Related to user-facing or internal documentation label Apr 2, 2026
@codspeed-hq
Copy link
Copy Markdown

codspeed-hq bot commented Apr 2, 2026

Merging this PR will not alter performance

✅ 48 untouched benchmarks
⏩ 3 skipped benchmarks1


Comparing om/04-02-docs_allocator_improve_doc_comment_examples_for_vec2_vec_ (de955d2) with om/04-02-perf_allocator_increase_initial_chunk_size_from_512b_to_16kb (b997217)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 om/04-02-perf_allocator_increase_initial_chunk_size_from_512b_to_16kb (cdaac4a) during the generation of this report, so 39a3e56 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

@overlookmotel overlookmotel marked this pull request as ready for review April 2, 2026 13:57
Copilot AI review requested due to automatic review settings April 2, 2026 13:57
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 Rust doc-comment code fences in vec2::Vec to keep examples formatted as Rust after the bumpalo dependency removal, while preventing them from being executed as doctests.

Changes:

  • Convert doc examples from fenced blocks labeled text to ignore.
  • Fix code fence closers to standard delimiters (instead oftext).

@overlookmotel overlookmotel force-pushed the om/04-02-docs_allocator_improve_doc_comment_examples_for_vec2_vec_ branch from 4b25323 to de955d2 Compare April 2, 2026 14:55
@overlookmotel overlookmotel force-pushed the om/04-02-perf_allocator_increase_initial_chunk_size_from_512b_to_16kb branch from b997217 to cdaac4a Compare April 2, 2026 14:55
@overlookmotel overlookmotel self-assigned this Apr 2, 2026
@overlookmotel overlookmotel added the A-allocator Area - Allocator label Apr 2, 2026
@overlookmotel overlookmotel added the 0-merge Merge with Graphite Merge Queue label Apr 2, 2026 — with Graphite App
@graphite-app
Copy link
Copy Markdown
Contributor

graphite-app bot commented Apr 2, 2026

Merge activity

Follow-on after #18168.

With the removal of `bumpalo` dependency, the examples in doc comments in `vec2::Vec` would no longer compile. That PR marked them all as `text` to prevent them running as doctests. Change them to `ignore` instead. That's preferable as it at least makes sure they're valid Rust syntax.
@graphite-app graphite-app bot force-pushed the om/04-02-perf_allocator_increase_initial_chunk_size_from_512b_to_16kb branch from cdaac4a to 91cf105 Compare April 2, 2026 15:12
@graphite-app graphite-app bot force-pushed the om/04-02-docs_allocator_improve_doc_comment_examples_for_vec2_vec_ branch from de955d2 to 7159d51 Compare April 2, 2026 15:12
@graphite-app graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Apr 2, 2026
Base automatically changed from om/04-02-perf_allocator_increase_initial_chunk_size_from_512b_to_16kb to main April 2, 2026 15:19
@graphite-app graphite-app bot merged commit 7159d51 into main Apr 2, 2026
28 checks passed
@graphite-app graphite-app bot deleted the om/04-02-docs_allocator_improve_doc_comment_examples_for_vec2_vec_ branch April 2, 2026 15:20
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