Minor: improve filter documentation #6317
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
commented
Aug 28, 2024
| /// Returns a filtered `values` [Array] where the corresponding elements of | ||
| /// `predicate` are `true`. | ||
| /// | ||
| /// See also [`FilterBuilder`] for more control over the filtering process. |
There was a problem hiding this comment.
this link is important I think
crepererum
approved these changes
Aug 28, 2024
gstvg
approved these changes
Aug 29, 2024
|
Thank you @crepererum and @gstvg |
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?
Rationale for this change
While reviewing #6304 with @crepererum and @gstvg I found the documentaiton on filtering could be clearer (basically make it easier to understand the API locally)
What changes are included in this PR?
Are there any user-facing changes?
documentation only, no functional changes