Minor: improve documentation to StringView trim #12629
Merged
Conversation
This file contains 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
alamb
force-pushed
the
alamb/more_trim_docs
branch
from
0e211b9
to
38210c9
Compare
comphead
reviewed
Sep 26, 2024
| /// raw must be a valid view | ||
| /// substr must be a valid substring of raw | ||
| /// # Safety | ||
| /// original_view must be a valid view |
There was a problem hiding this comment.
Good call -- I tried to clarify in c8668df
comphead
approved these changes
Sep 26, 2024
|
Thanks again @comphead |
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.
Which issue does this PR close?
Follow on to #12395 from @Rachelint
Rationale for this change
Part of reviewing https://github.com/apache/datafusion/pull/12395I spent some non trivial time reading this code, and I wanted to encodde my learnings as comments
What changes are included in this PR?
Are these changes tested?
No code, just docs and name changes
Are there any user-facing changes?
No, this is all internal code