Add Deprecation Warning for Namespace Change #805
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
Contributor
SimonBoothroyd
commented
Jan 6, 2021
SimonBoothroyd
commented
- Tag issue being addressed (Migrate openforcefield to openff.toolkit #804)
- Add tests
- Update docstrings/documentation, if applicable
- Lint codebase
- Update changelog
jaimergp
reviewed
Jan 6, 2021
Co-authored-by: Jaime Rodríguez-Guerra <jaimergp@users.noreply.github.com>
mattwthompson
approved these changes
Jan 6, 2021
Comment on lines
+9
to
+10
| warnings.warn( | ||
| "Importing this package as `import openforcefield.XXX` and " |
There was a problem hiding this comment.
Non-blocking, but it would be nice to have more precise language here
- The entire package is never really imported
- Saying "importing this module as ... " is incorrect when only a class is imported
- Likewise, "importing this class/etc. ..." is also incorrect when entire modules are imported
Maybe something more general like "Importing components from this package as ... " / "From version 0.9.0 onwards, components of this package will need to be imported as ..." ?
Co-authored-by: Matt Thompson <mattwthompson@protonmail.com>
Co-authored-by: Matt Thompson <mattwthompson@protonmail.com>
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.