fix: emit DeprecationWarning on current_state setter#605
Merged
Conversation
The getter already warned, but the setter was silent. Now both consistently emit DeprecationWarning pointing to `configuration`. Also adds a Sphinx `deprecated` directive to the docstring so the API docs render the deprecation notice.
fgmacedo
force-pushed
the
fix/current-state-setter-deprecation
branch
from
c0f626f to
fa71983
Compare
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #605 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 42 42
Lines 5015 5019 +4
Branches 810 810
=========================================
+ Hits 5015 5019 +4
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
1 participant
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.
Summary
current_stategetter already emittedDeprecationWarning, but the setter was silent. Now both consistently warn, pointing users toconfiguration/configuration_values... deprecated:: 3.0.0Sphinx directive to the docstring so the API docs on ReadTheDocs render the deprecation notice.Closes #604