From cb05d72da8e3dad17bbeff88a2b6b5ece225ec49 Mon Sep 17 00:00:00 2001 From: pc494 Date: Thu, 21 Mar 2024 14:19:50 +0000 Subject: [PATCH] changelog: util adjustments included --- .github/PULL_REQUEST_TEMPLATE.md | 12 +++++------- CHANGELOG.rst | 3 ++- README.rst | 4 ++-- 3 files changed, 9 insertions(+), 10 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 4f4975054..9e2ba683f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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. \ No newline at end of file diff --git a/CHANGELOG.rst b/CHANGELOG.rst index a74d42b9f..e4aa8b13e 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -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 ------- diff --git a/README.rst b/README.rst index d7b14fbe7..9f23ac060 100644 --- a/README.rst +++ b/README.rst @@ -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