Skip to content

Commit

Permalink
Option name change
Browse files Browse the repository at this point in the history
PR comment; change option to `autogenerate_spectrumlist`.
  • Loading branch information
tbowers7 committed Jul 31, 2023
1 parent 634f01d commit 36f8488
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions specutils/io/registers.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ def _astropy_has_priorities():


def data_loader(label, identifier=None, dtype=Spectrum1D, extensions=None,
priority=0, force=False, opt_in_spectrumlist=True, verbose=False):
priority=0, force=False, autogenerate_spectrumlist=True, verbose=False):
"""
Wraps a function that can be added to an `~astropy.io.registry` for custom
file reading.
Expand All @@ -51,9 +51,9 @@ def data_loader(label, identifier=None, dtype=Spectrum1D, extensions=None,
force : bool, optional
Whether to override any existing function if already present.
Default is ``False``. Passed down to astropy registry.
opt_in_spectrumlist : bool, optional
Whether to register a SpectrumList reader for any data_loader that
reads Spectrum1D objects. Default is ``True``.
autogenerate_spectrumlist : bool, optional
Whether to automatically register a SpectrumList reader for any
data_loader that reads Spectrum1D objects. Default is ``True``.
verbose : bool
Print extra info.
Expand Down Expand Up @@ -110,7 +110,7 @@ def decorator(func):

# Optionally register a SpectrumList reader for any data_loader that
# reads Spectrum1D objects.
if dtype is Spectrum1D and opt_in_spectrumlist:
if dtype is Spectrum1D and autogenerate_spectrumlist:
def load_spectrum_list(*args, **kwargs):
return SpectrumList([ func(*args, **kwargs) ])

Expand Down

0 comments on commit 36f8488

Please sign in to comment.