Open
Conversation
dlarocque
reviewed
Mar 19, 2026
Contributor
There was a problem hiding this comment.
Can you add @returns tags and usage examples to expression docs where those are missing
Comment on lines
+3140
to
+3142
| between(lowerBound: unknown, upperBound: unknown): BooleanExpression; | ||
|
|
||
| between(lowerBound: unknown, upperBound: unknown): BooleanExpression { |
Contributor
There was a problem hiding this comment.
Could we make these number types? What other types can evaluate to a lower or upper bound?
| * the `lowerBound` (inclusive) and `upperBound` (inclusive). | ||
| * | ||
| * @example | ||
| * ``` |
Contributor
There was a problem hiding this comment.
Applies to all other docs like this
Suggested change
| * ``` | |
| * ```typescript |
| * | ||
| * @remarks This Expression can only be used within a `Search` stage. | ||
| * | ||
| * @param rquery Define the search query using the search DTS (TODO(search) link). |
Contributor
There was a problem hiding this comment.
Is this supposed to say 'search DSL'?
Co-authored-by: Daniel La Rocque <dlarocque@google.com>
Co-authored-by: Daniel La Rocque <dlarocque@google.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.
search