docs(allocator): improve doc comment examples for vec2::Vec#20969
Merged
graphite-app[bot] merged 1 commit intomainfrom Apr 2, 2026
Merged
Conversation
This was referenced Apr 2, 2026
Member
Author
Merging this PR will not alter performance
Comparing 
Footnotes
|
Contributor
There was a problem hiding this comment.
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
texttoignore. - Fix code fence closers to standard
delimiters (instead oftext).
This was referenced Apr 2, 2026
4b25323 to
de955d2
Compare
b997217 to
cdaac4a
Compare
Contributor
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.
cdaac4a to
91cf105
Compare
de955d2 to
7159d51
Compare
Base automatically changed from
om/04-02-perf_allocator_increase_initial_chunk_size_from_512b_to_16kb
to
main
April 2, 2026 15:19
leaysgur
pushed a commit
that referenced
this pull request
Apr 7, 2026
### 🐛 Bug Fixes - fc7f60c allocator: Revert changes to `get_current_chunk_footer_field_offset` (#20964) (overlookmotel) - 31316c8 semantic: Rebind class expressions before identifier checks (#20916) (camc314) ### ⚡ Performance - fb52383 napi/parser, linter/plugins: Clear buffers and source texts earlier (#21025) (overlookmotel) - 3b7dec4 napi/parser, linter/plugins: Use `utf8Slice` for decoding UTF-8 strings (#21022) (overlookmotel) - 012c924 napi/parser, linter/plugins: Speed up decoding strings in raw transfer (#21021) (overlookmotel) - 55e1e9b napi/parser, linter/plugins: Initialize vars as 0 (#21020) (overlookmotel) - c25ef02 napi/parser, linter/plugins: Simplify branch condition in `deserializeStr` (#21019) (overlookmotel) - 9f494c3 napi/parser, linter/plugins: Raw transfer use `String.fromCharCode` in string decoding (#21018) (overlookmotel) - 91cf105 allocator: Increase initial chunk size from 512B to 16KB (#20968) (overlookmotel) - cbc0c21 allocator: Add `#[cold]` to to error handling functions (#20967) (overlookmotel) - 0503a78 napi/parser, linter/plugins: Faster deserialization of `raw` fields (#20923) (overlookmotel) - a24f75e napi/parser: Optimize string deserialization for non-ASCII sources (#20834) (Joshua Tuddenham) ### 📚 Documentation - c78a57a syntax: Fix typo (#21044) (camc314) - f5e228f allocator: Fix typo in comment (#20972) (overlookmotel) - 7159d51 allocator: Improve doc comment examples for `vec2::Vec` (#20969) (overlookmotel) - b1da750 allocator, data_structures: Correct comments (#20966) (overlookmotel) Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-on after #18168.
With the removal of
bumpalodependency, the examples in doc comments invec2::Vecwould no longer compile. That PR marked them all astextto prevent them running as doctests. Change them toignoreinstead. That's preferable as it at least makes sure they're valid Rust syntax.