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

feat(python): Add UnstableWarning for unstable functionality #13948

Merged
merged 13 commits into from
Jan 26, 2024
Merged

Conversation

stinodego
Copy link
Member

@stinodego stinodego commented Jan 24, 2024

Closes #12432

"unstable" is the new name for "experimental".

Changes

  • Add Config.warn_unstable, which enables issuing warnings when unstable functionality is used. It is disabled by default.
  • Add UnstableWarning
  • Add @unstable decorator and issue_unstable_warning util.
  • Make functionality that was currently marked as 'experimental' throw an UnstableWarning (if setting enabled). Update docstring warnings.
  • Mark all rolling functions, streaming functionality, and cut/qcut as experimental.
  • Add documentation on unstable functionality to the versioning docs.

@stinodego stinodego changed the title Add UnstableWarning feat(python): Add UnstableWarning for unstable functionality Jan 24, 2024
@github-actions github-actions bot added enhancement New feature or an improvement of an existing feature python Related to Python Polars labels Jan 24, 2024
@stinodego stinodego marked this pull request as ready for review January 24, 2024 15:00
@stinodego stinodego added this to the 1.0.0 milestone Jan 24, 2024
@ritchie46 ritchie46 merged commit 3a5fc8f into main Jan 26, 2024
17 checks passed
@ritchie46 ritchie46 deleted the experimental branch January 26, 2024 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or an improvement of an existing feature python Related to Python Polars
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add warning for experimental functionality
2 participants