Skip to content

Commit

Permalink
Update progress_bar description in doc strings
Browse files Browse the repository at this point in the history
  • Loading branch information
larrybradley committed Feb 28, 2025
1 parent 3411e38 commit 9c42911
Show file tree
Hide file tree
Showing 8 changed files with 8 additions and 24 deletions.
2 changes: 0 additions & 2 deletions photutils/datasets/images.py
Original file line number Diff line number Diff line change
Expand Up @@ -159,8 +159,6 @@ def make_model_image(shape, model, params_table, *, model_shape=None,
Whether to display a progress bar while adding the sources
to the image. The progress bar requires that the `tqdm
<https://tqdm.github.io/>`_ optional dependency be installed.
Note that the progress bar does not currently work in the
Jupyter console due to limitations in ``tqdm``.
Returns
-------
Expand Down
2 changes: 0 additions & 2 deletions photutils/psf/epsf.py
Original file line number Diff line number Diff line change
Expand Up @@ -276,8 +276,6 @@ class EPSFBuilder:
Whether to print the progress bar during the build
iterations. The progress bar requires that the `tqdm
<https://tqdm.github.io/>`_ optional dependency be installed.
Note that the progress bar does not currently work in the
Jupyter console due to limitations in ``tqdm``.
norm_radius : float, optional
The pixel radius over which the ePSF is normalized.
Expand Down
4 changes: 0 additions & 4 deletions photutils/psf/photometry.py
Original file line number Diff line number Diff line change
Expand Up @@ -265,8 +265,6 @@ class for more information.
Whether to display a progress bar when fitting the sources
(or groups). The progress bar requires that the `tqdm
<https://tqdm.github.io/>`_ optional dependency be installed.
Note that the progress bar does not currently work in the
Jupyter console due to limitations in ``tqdm``.
Notes
-----
Expand Down Expand Up @@ -1565,8 +1563,6 @@ class IterativePSFPhotometry(ModelImageMixin):
Whether to display a progress bar when fitting the sources
(or groups). The progress bar requires that the `tqdm
<https://tqdm.github.io/>`_ optional dependency be installed.
Note that the progress bar does not currently work in the
Jupyter console due to limitations in ``tqdm``.
Notes
-----
Expand Down
4 changes: 1 addition & 3 deletions photutils/psf/simulation.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,7 @@ def make_psf_model_image(shape, psf_model, n_sources, *, model_shape=None,
progress_bar : bool, optional
Whether to display a progress bar when creating the sources. The
progress bar requires that the `tqdm <https://tqdm.github.io/>`_
optional dependency be installed. Note that the progress
bar does not currently work in the Jupyter console due to
limitations in ``tqdm``.
optional dependency be installed.
**kwargs
Keyword arguments are accepted for additional model parameters.
Expand Down
2 changes: 0 additions & 2 deletions photutils/segmentation/catalog.py
Original file line number Diff line number Diff line change
Expand Up @@ -240,8 +240,6 @@ class SourceCatalog:
``fluxfrac_radius``, ``circular_photometry``, ``centroid_win``,
``centroid_quad``). The progress bar requires that the `tqdm
<https://tqdm.github.io/>`_ optional dependency be installed.
Note that the progress bar does not currently work in the
Jupyter console due to limitations in ``tqdm``.
Notes
-----
Expand Down
4 changes: 1 addition & 3 deletions photutils/segmentation/deblend.py
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,7 @@ def deblend_sources(data, segment_img, npixels, *, labels=None, nlevels=32,
deblended. If multiprocessing is used (``nproc > 1``), the ID
shown is the last source label that was deblended. The progress
bar requires that the `tqdm <https://tqdm.github.io/>`_ optional
dependency be installed. Note that the progress bar does not
currently work in the Jupyter console due to limitations in
``tqdm``.
dependency be installed.
Returns
-------
Expand Down
11 changes: 5 additions & 6 deletions photutils/segmentation/finder.py
Original file line number Diff line number Diff line change
Expand Up @@ -98,12 +98,11 @@ class SourceFinder:
progress_bar : bool, optional
Whether to display a progress bar. If ``nproc = 1``, then the
ID shown after the progress bar is the source label being
deblended. If multiprocessing is used (``nproc > 1``), the ID
shown is the last source label that was deblended. The progress
bar requires that the `tqdm <https://tqdm.github.io/>`_ optional
dependency be installed. Note that the progress bar does not
currently work in the Jupyter console due to limitations in
``tqdm``. This keyword is ignored unless ``deblend=True``.
deblended. If multiprocessing is used (``nproc > 1``), the
ID shown is the last source label that was deblended. The
progress bar requires that the `tqdm <https://tqdm.github.io/>`_
optional dependency be installed. This keyword is ignored unless
``deblend=True``.
See Also
--------
Expand Down
3 changes: 1 addition & 2 deletions photutils/utils/depths.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,7 @@ class ImageDepth:
progress_bar : bool, optional
Whether to display a progress bar. The progress bar requires
that the `tqdm <https://tqdm.github.io/>`_ optional dependency
be installed. Note that the progress bar does not currently work
in the Jupyter console due to limitations in ``tqdm``.
be installed.
Attributes
----------
Expand Down

0 comments on commit 9c42911

Please sign in to comment.