-
Notifications
You must be signed in to change notification settings - Fork 85
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
CLN: Deprecate the edit parameter to configure_traits #1311
Merged
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
Augment and strengthen tests for deprecation of edit parameter
mdickinson
commented
Oct 13, 2020
mdickinson
changed the title
Deprecate the edit parameter to configure_traits
CLN: Deprecate the edit parameter to configure_traits
Oct 13, 2020
@kitchoi Given that you looked at an earlier incarnation of this PR, would you be willing to review? |
kitchoi
approved these changes
Oct 13, 2020
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Thanks! |
4 tasks
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.
This PR builds on the work of @avats-dev in #1272 to deprecate the
edit
parameter toconfigure_traits
. Ifedit
is given explicitly (either asTrue
orFalse
), then aDeprecationWarning
is issued. Apart from that, the behaviour remains the same as before in all three cases we care about (edit
passed asTrue
,edit
passed asFalse
, oredit
not passed).Closes #1271.
Checklist
docs/source/traits_api_reference
) (deprecation note added to docstring)[ ] Update User manual ((not needed - thedocs/source/traits_user_manual
)edit
functionality is not documented)[ ] Update type annotation hints in(no change needed until edit is actually removed)traits-stubs