chore: document TrimWhitespace string_view lifetime requirement#60
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Documents the lifetime requirement of TrimWhitespace, which returns a std::string_view into its input buffer, to help prevent callers from accidentally creating dangling views (e.g., by passing a temporary std::string).
Changes:
- Added a clarifying comment explaining that
TrimWhitespacereturns a view into the input and the input buffer must outlive the returnedstd::string_view.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
codepuncher
force-pushed
the
chore/document-trimwhitespace-lifetime
branch
from
c9e9ae2 to
a281897
Compare
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.
TrimWhitespacereturns astd::string_viewinto its input buffer. Calling it with a temporary (e.g.TrimWhitespace(std::string{"..."})) produces a dangling view. Documents the lifetime requirement so callers don't misuse it.Comment-only change; no behavioral impact.