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

CLN: Deprecate the edit parameter to configure_traits #1311

Merged
merged 14 commits into from
Oct 13, 2020
Merged

Conversation

mdickinson
Copy link
Member

@mdickinson mdickinson commented Oct 13, 2020

This PR builds on the work of @avats-dev in #1272 to deprecate the edit parameter to configure_traits. If edit is given explicitly (either as True or False), then a DeprecationWarning is issued. Apart from that, the behaviour remains the same as before in all three cases we care about (edit passed as True, edit passed as False, or edit not passed).

Closes #1271.

Checklist

  • Tests
  • Update API reference (docs/source/traits_api_reference) (deprecation note added to docstring)
  • [ ] Update User manual (docs/source/traits_user_manual) (not needed - the edit functionality is not documented)
  • [ ] Update type annotation hints in traits-stubs (no change needed until edit is actually removed)

@mdickinson mdickinson changed the title Deprecate the edit parameter to configure_traits CLN: Deprecate the edit parameter to configure_traits Oct 13, 2020
@mdickinson
Copy link
Member Author

@kitchoi Given that you looked at an earlier incarnation of this PR, would you be willing to review?

Copy link
Contributor

@kitchoi kitchoi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mdickinson
Copy link
Member Author

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deprecate the edit argument to configure_traits
3 participants