Skip to content

Commit

Permalink
changelog: util adjustments included
Browse files Browse the repository at this point in the history
  • Loading branch information
pc494 committed Mar 21, 2024
1 parent 54d286e commit cb05d72
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 10 deletions.
12 changes: 5 additions & 7 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
---
name: Pull request
about: A pull request that fixes a bug or adds a feature

name
---

**Checklist**
- [ ] Updated CHANGELOG.md
- [ ] Marked as finished

- [ ] implementation steps
- [ ] update the Changelog
- [ ] mark as ready for review

**What does this PR do? Please describe and/or link to an open issue.**
A clear and concise description of what the code in this PR does. Does it fix a bug or add a new feature?
If it is related to an open issue, reference it here.
3 changes: 2 additions & 1 deletion CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,13 @@ Deprecated
- Deprecated `pyxem.generators.virtual_image_generator.VirtualImageGenerator` in
favor of `pyxem.signals.CommonDiffraction.get_virtual_image` (#1014)
- Several utility modules have been deprecated: utils.{pyfai,segement,virtual_images,background_utils,cluster_tools} (#1060 & #1030).
- `insitu_utils` is now private.
- The following utils: `insitu_utils`, `correlations_utils` and `pixelated_stem_tools` are now private.
- `utils.vector_utils`, prefer `utils.vectors`

Deleted
-------
- Several expired methods of `Diffraction2D` associated with radial integration (#998)
- The `peak_find_lazy` method of `Diffraction2D` (#1040)

Changed
-------
Expand Down
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
.. |Actions| image:: https://github.com/pyxem/pyxem/workflows/build/badge.svg
.. _Actions: https://github.com/pyxem/pyxem/actions

.. |Coveralls| image:: https://coveralls.io/repos/github/pyxem/pyxem/badge.svg?branch=master
.. _Coveralls: https://coveralls.io/github/pyxem/pyxem?branch=master
.. |Coveralls| image:: https://coveralls.io/repos/github/pyxem/pyxem/badge.svg?branch=main
.. _Coveralls: https://coveralls.io/github/pyxem/pyxem?branch=main

.. |pypi_version| image:: http://img.shields.io/pypi/v/pyxem.svg?style=flat
.. _pypi_version: https://pypi.python.org/pypi/pyxem
Expand Down

0 comments on commit cb05d72

Please sign in to comment.