docs: improve docstrings for as_scalar() and as_table() #11613
Conversation
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
cpcloud
requested changes
Sep 29, 2025
|
|
||
| def as_scalar(self) -> ir.Scalar: | ||
| """Inform ibis that the table expression should be treated as a scalar. | ||
| """Inform ibis to treat this table as a 1 row, 1 column scalar. |
There was a problem hiding this comment.
Suggested change
| """Inform ibis to treat this table as a 1 row, 1 column scalar. | |
| """Tell ibis to treat this value as 1 row, 1 column table, referred to as a *scalar*. |
| def as_scalar(self): | ||
| """Inform ibis that the expression should be treated as a scalar. | ||
| def as_scalar(self) -> Scalar: | ||
| """Inform ibis to treat this scalar expression as a free-standing scalar. |
There was a problem hiding this comment.
Suggested change
| """Inform ibis to treat this scalar expression as a free-standing scalar. | |
| """Tell ibis to treat this expression as a single scalar value. |
|
|
||
| def as_scalar(self) -> ir.Scalar: | ||
| """Convert an expression to a scalar.""" | ||
| """Inform ibis to treat the Scalar, Column, or Table as a scalar. |
There was a problem hiding this comment.
Suggested change
| """Inform ibis to treat the Scalar, Column, or Table as a scalar. | |
| """Tell ibis to treat the expression as a scalar. |
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.
I tried to make these more beginner friendly. "Scalar subquery" is very overwhelming for someone coming from pandas, and I think should be treated as an implementation detail.
I tried to add more examples, to actually show WHY you would want to use this.