Add inline documentation to Vector::reserve and Vector::reserve_exact.#114563
Merged
akien-mga merged 1 commit intogodotengine:masterfrom Jan 5, 2026
Merged
Add inline documentation to Vector::reserve and Vector::reserve_exact.#114563akien-mga merged 1 commit intogodotengine:masterfrom
Vector::reserve and Vector::reserve_exact.#114563akien-mga merged 1 commit intogodotengine:masterfrom
Conversation
Ivorforce
force-pushed
the
vector-reserve-doc
branch
2 times, most recently
from
9911ee1 to
4d35512
Compare
clayjohn
reviewed
Jan 3, 2026
core/templates/vector.h
Outdated
| } | ||
|
|
||
| /// Reserves capacity for at least p_size total elements. | ||
| /// You can call this before repeated insertions to improve performance. |
Member
There was a problem hiding this comment.
I would add a note that this follows the 1.5x growth pattern and may reserve more than what is asked for.
Similarly I would clarify below that reserve exact only reserves exactly what is asked for and may be sub optimal if called repeatedly
Member
Author
There was a problem hiding this comment.
I rephrased and added some more detail. Does this help?
Ivorforce
force-pushed
the
vector-reserve-doc
branch
from
4d35512 to
7a3c74e
Compare
Member
|
Thanks! |
rivie13
pushed a commit
to rivie13/Phoenix-Agentic-Engine
that referenced
this pull request
Feb 16, 2026
Add inline documentation to `Vector::reserve` and `Vector::reserve_exact`.
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
3 participants
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.
These functions are not inherently clear and should be documented (especially regarding their difference).
As template functions, the most appropriate place is in-line with the code (as with other methods in the same class).
Other templates (outside
CowData, which is not commonly used directly), no other type offersreserve_exactyet.