Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(python): Add doc example for datetime_ranges #13695

Merged
merged 7 commits into from
Jan 14, 2024

Conversation

NedJWestern
Copy link
Contributor

@NedJWestern NedJWestern commented Jan 13, 2024

See #13161

@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars labels Jan 13, 2024
@NedJWestern
Copy link
Contributor Author

The test fails due to a data frame column width formatting issue. Suggestions?

@mcrumiller
Copy link
Contributor

mcrumiller commented Jan 13, 2024

Alternatively (if the issue is that the docstring was too wide) you can simply add # noqa: W505 after the final """.

"""
    This docstring is way too wide but it doesn't matter because we tell ruff to ignore this type of error
""" # noqa: W505

Co-authored-by: Alexander Beedie <alexander-beedie@users.noreply.github.com>
@NedJWestern
Copy link
Contributor Author

Alternatively (if the issue is that the docstring was too wide) you can simply add # noqa: W505 after the final """.

"""
    This docstring is way too wide but it doesn't matter because we tell ruff to ignore this type of error
""" # noqa: W505

Ah, that's what I was looking for!

@NedJWestern
Copy link
Contributor Author

Apologies for the false starts, I need to get the doctests running locally.

@stinodego stinodego changed the title docs(python): add new docstring docs(python): Add docstring for datetime_ranges Jan 14, 2024
@stinodego stinodego changed the title docs(python): Add docstring for datetime_ranges docs(python): Add doc example for datetime_ranges Jan 14, 2024
@stinodego stinodego merged commit 34b53ee into pola-rs:main Jan 14, 2024
13 checks passed
r-brink pushed a commit to r-brink/polars that referenced this pull request Jan 24, 2024
Co-authored-by: Ned Western <Ned.Western@aemo.com.au>
Co-authored-by: Alexander Beedie <alexander-beedie@users.noreply.github.com>
Co-authored-by: Stijn de Gooijer <stijndegooijer@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation python Related to Python Polars
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants