Skip to content

Commit 4e03187

Browse files
committed
Update what's new
1 parent f4e1af9 commit 4e03187

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

docs/whats_new/3.0.rst

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,15 @@
66
What's New in Photutils 3.0?
77
****************************
88

9+
Photutils 3.0 is a major release that includes a small number of
10+
:ref:`breaking changes <whatsnew-3.0-breaking-changes>` alongside
11+
several :ref:`new deprecations <whatsnew-3.0-deprecations>`. While these
12+
deprecations will now trigger warning messages, they will not break
13+
your code. We are intentionally providing a long deprecation period to
14+
give users ample time to update their code before these features are
15+
completely removed in version 4.0. Please review the :ref:`API Changes
16+
<whatsnew-3.0-api-changes>` section before upgrading.
17+
918
Here we highlight some of the new functionality of the 3.0 release.
1019
In addition to these changes, Photutils 3.0 includes several
1120
smaller improvements and bug fixes, which are described in the full
@@ -451,9 +460,13 @@ and in the ``Notes`` section of each ``to_sky`` and ``to_pixel`` method
451460
docstring.
452461

453462

463+
.. _whatsnew-3.0-api-changes:
464+
454465
API Changes
455466
===========
456467

468+
.. _whatsnew-3.0-deprecations:
469+
457470
New Deprecations
458471
----------------
459472

@@ -843,18 +856,11 @@ For the ``psf`` package, the previously deprecated
843856
:class:`~photutils.psf.ImagePSF` instead.
844857

845858

859+
.. _whatsnew-3.0-breaking-changes:
860+
846861
Breaking Changes
847862
----------------
848863

849-
Star Finder ``orientation`` Column Units
850-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
851-
852-
The ``orientation`` (was ``pa``) column in the output tables
853-
from :class:`~photutils.detection.IRAFStarFinder` and
854-
:class:`~photutils.detection.StarFinder` is now a ``Quantity`` array in
855-
in the range of [0, 360) degrees.
856-
857-
858864
Consistent Default ``min_separation`` for Star Finders
859865
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
860866

@@ -894,7 +900,7 @@ in the range [0, 360) degrees.
894900
Star Finder ``pa`` Column Units and Range
895901
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
896902

897-
The ``pa`` (position angle) column in the output tables
903+
The ``orientation`` (was ``pa``) column in the output tables
898904
from :class:`~photutils.detection.IRAFStarFinder` and
899905
:class:`~photutils.detection.StarFinder` is now a ``Quantity`` array in
900906
the range of [0, 360) degrees.

0 commit comments

Comments
 (0)