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

add warning message for the deprecated methods #1692

Merged
merged 3 commits into from Jan 11, 2024

Conversation

melodyyzh
Copy link
Contributor

@melodyyzh melodyyzh commented Jan 7, 2024

Description

Added deprecation warnings for the following methods:

  • _InternalCustomUpdater.update.
  • _InternalCustomTuner.tune.
  • _InternalCustomWriter.write.
  • HDF5Log.write.

Motivation and context

Resolves #1648

How has this been tested?

Used the existing python tests

Change log

Deprecated:

* ``_InternalCustomUpdater.update``.
  (`#1692 <https://github.com/glotzerlab/hoomd-blue/pull/1692>`__).
* ``_InternalCustomTuner.tune``.
  (`#1692 <https://github.com/glotzerlab/hoomd-blue/pull/1692>`__).  
* ``_InternalCustomWriter.write``.
  (`#1692 <https://github.com/glotzerlab/hoomd-blue/pull/1692>`__).
* ``HDF5Log.write``.
  (`#1692 <https://github.com/glotzerlab/hoomd-blue/pull/1692>`__).

Checklist:

@melodyyzh melodyyzh requested review from a team as code owners January 7, 2024 01:58
@melodyyzh melodyyzh requested review from joaander, tommy-waltmann and pepak13 and removed request for a team January 7, 2024 01:58
@melodyyzh melodyyzh added the validate Execute long running validation tests on pull requests label Jan 8, 2024
Copy link
Member

@joaander joaander left a comment

Choose a reason for hiding this comment

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

Thanks! I have some suggestions to fix the grammar which I will apply and then merge.

hoomd/tune/custom_tuner.py Outdated Show resolved Hide resolved
hoomd/tune/custom_tuner.py Outdated Show resolved Hide resolved
hoomd/tune/custom_tuner.py Outdated Show resolved Hide resolved
hoomd/update/custom_updater.py Outdated Show resolved Hide resolved
hoomd/update/custom_updater.py Outdated Show resolved Hide resolved
hoomd/write/custom_writer.py Outdated Show resolved Hide resolved
hoomd/write/custom_writer.py Outdated Show resolved Hide resolved
hoomd/write/hdf5.py Outdated Show resolved Hide resolved
hoomd/write/hdf5.py Outdated Show resolved Hide resolved
sphinx-doc/deprecated.rst Outdated Show resolved Hide resolved
@joaander joaander merged commit 4ca9227 into trunk-minor Jan 11, 2024
40 checks passed
@joaander joaander deleted the deprecate_custom_methods branch January 11, 2024 21:04
@melodyyzh melodyyzh mentioned this pull request Jan 16, 2024
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
validate Execute long running validation tests on pull requests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants