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
import GPUNotAvailableError to error.py #1694
Conversation
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.
In the referenced issue (#1649), it states that this PR should also "Note in the documentation that util.GPUNotAvailableError is deprecated and will move to error."
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.
To complete the move in a backward compatible way:
- Move
_NoGPU
fromutil.py
toerror.py
. - Adjust all uses of
_NoGPU
to import it fromerror
. - Add
GPUNotAvailableError
tomodule-hoomd-errors.rst
so it appears in the documentation. - Remove the definition of
GPUNotAvailableError
fromutil.py
and replace it with an import ofhoomd.error.GPUNotAvailableError
to preserve backward compatibility. - Note the deprecation in
deprecated.rst
.
Merge trunk-minor
into move_GPUNotAvailableError
first to avoid creating conflicts in deprecated.rst
.
…md-blue into move_GPUNotAvailableError
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.
Thanks!
Description
Imported
GPUNotAvailableError
inerror.py
.Will remove
util.GPNotavailableError
in a branch offtrunk-major
after this branch is mergedMotivation and context
util
should hold utility methods anderror
should hold error classes.Resolves #1649
How has this been tested?
Change log
Checklist:
sphinx-doc/credits.rst
) in the pull request source branch.