docs(python): Adding additional examples to docstrings #13555
Closed
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
r-brink
requested review from
ritchie46,
stinodego,
c-peters,
alexander-beedie and
MarcoGorelli
as code owners
github-actions
bot
added
documentation
stinodego
requested changes
Jan 9, 2024
Comment on lines
+299
to
+300
|
|
||
| >>> s = pl.Series([[2, 1, 2], [5, 4, 5]]) |
There was a problem hiding this comment.
You don't have to repeat the Series definition as it didn't change.
Suggested change
| >>> s = pl.Series([[2, 1, 2], [5, 4, 5]]) |
| Examples | ||
| -------- | ||
| >>> s = pl.Series([[2, 1, 2], [5, 4, 5]]) | ||
| >>> s.list.unique() |
There was a problem hiding this comment.
This one should be skipped as it may fail (the result is not guaranteed to be in this order).
Suggested change
| >>> s.list.unique() | |
| >>> s.list.unique() # doctest: +SKIP |
Comment on lines
+1865
to
+1866
| >>> s = pl.Series("a", [1, None, 4]) | ||
| >>> s.nan_max() |
There was a problem hiding this comment.
This should showcase a nan value, e.g. float("nan").
Best to give two examples, one where the series has a NaN, one where it doesn't.
| @@ -1846,6 +1876,12 @@ def nan_min(self) -> int | float | date | datetime | timedelta | str: | |||
| This differs from numpy's `nanmax` as numpy defaults to propagating NaN values, | |||
| whereas polars defaults to ignoring them. | |||
|
|
|||
| Examples | |||
| -------- | |||
| >>> s = pl.Series("a", [1, None, 4]) | |||
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.
Adding more missing docstrings as discussed here: #13161