CR

CHANGELOG.rst

@@ -1,4 +1,3 @@
-<<<<<<<< HEAD:CHANGELOG.rst
 1.0.0 (2024-05-31)
 ==================
 
@@ -21,44 +20,3 @@ The main changes from the previous release of `pfsspy` are as follows:
 * The ``GongSynopticMap`` class has moved into `sunpy`, note that the new
   class in ``sunpy`` is slightly different in that it does not modify the
   header.
-|||||||| parent of cc08f79 (Handle old functions and update examples):docs/changelog.rst
-.. _sunkit-magex-changelog:
-
-**************
-Full Changelog
-**************
-
-1.0.0 (2024-05-31)
-==================
-
-This is the first release and aims to keep the API the same from `pfsspy` to
-`sunkit_magex`.  The main difference is that you will need to replace the
-import like so:
-
-  .. code-block:: python
-
-    # Before
-    import pfsspy
-    from pfsspy import tracing
-
-    # After
-    from sunkit_magex import pfss as pfsspy
-    from sunkit_magex.pfss import tracing
-
-The main changes from the previous release of `pfsspy` are as follows:
-
-* The ``GongSynopticMap`` class has moved into `sunpy`, note that the new
-  class in ``sunpy`` is slightly different in that it does not modify the
-  header.
-========
-.. _sunkit-magex-changelog:
-
-**************
-Full Changelog
-**************
-
-.. changelog::
-   :towncrier: ../
-   :towncrier-skip-if-empty:
-   :changelog_file: ../CHANGELOG.rst
->>>>>>>> cc08f79 (Handle old functions and update examples):docs/changelog.rst

changelog/63.breaking.2.rst

@@ -3,4 +3,5 @@ Deprecated the following pfss utils:
 - pfss.utils.fix_hmi_meta
 - pfss.utils.load_adapt
 
-These functions are no longer needed and will be removed.
+`If you want to fix metadata, read this how-to guide. <https://docs.sunpy.org/en/latest/how_to/fix_map_metadata.html>`__
+`If you want to load ADAPT maps, read this example. <https://docs.sunpy.org/en/latest/generated/gallery/saving_and_loading_data/load_adapt_fits_into_map.html>`__

sunkit_magex/pfss/utils.py

@@ -81,7 +81,7 @@ def fix_hmi_meta(hmi_map):
         hmi_map.meta.update(_earth_obs_coord_meta(hmi_map.meta['date-obs']))
 
 
-@deprecated('1.0', message="This is not required anymore. An example of how to load an ADAPT file is available in the documentation.")
+@deprecated('1.0', message="Use sunpy.map.Map or read https://docs.sunpy.org/en/latest/generated/gallery/saving_and_loading_data/load_adapt_fits_into_map.html")
 def load_adapt(adapt_path):
     """
     Parse adapt .fts file as a `sunpy.map.MapSequence`