Skip to content

Commit

Permalink
DOC: Fix broken intersphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
pllim committed Jan 25, 2022
1 parent 8a71875 commit 3db79bc
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions docs/cubeviz/import_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ application:

Cubeviz supports loading the following data formats:

* FITS file, `~astropy.io.fits.HDUList`, `~fits.hdu.hdulist.ImageHDU`, or
`~fits.hdu.hdulist.PrimaryHDU` that can be parsed as
* FITS file, `~astropy.io.fits.HDUList`, `~astropy.io.fits.ImageHDU`, or
`~astropy.io.fits.PrimaryHDU` that can be parsed as
`~specutils.Spectrum1D` 3D object, in which case the application
will attempt to automatically parse the data into the viewers as described
in :ref:`cubeviz-display-cubes`. This support includes the ASDF-in-FITS
Expand Down Expand Up @@ -67,7 +67,7 @@ method, which takes as input either the name of a local file or a
>>> cubeviz.load_data("/Users/demouser/data/cube_file.fits") # doctest: +SKIP

Theoretically, mix-and-match loading might be possible. For instance,
you may choose to load `~specutils.Spectrum1D` into one viewer, `~fits.hdu.hdulist.ImageHDU`
you may choose to load `~specutils.Spectrum1D` into one viewer, `~astropy.io.fits.ImageHDU`
into another, and Numpy array into the third one. However, user must ensure their
data units and WCS's are compatible. Therefore, while possible, it is not recommended unless
you know what you are doing.
Expand Down
2 changes: 1 addition & 1 deletion jdaviz/configs/cubeviz/plugins/parsers.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ def parse_data(app, file_obj, data_type=None, data_label=None):
----------
app : `~jdaviz.app.Application`
The application-level object used to reference the viewers.
file_obj : str, `~fits.hdu.hdulist.ImageHDU`, `~fits.hdu.hdulist.PrimaryHDU`, `~fits.hdu.hdulist.HDUList`, `~specutils.Spectrum1D`, or ndarray
file_obj : str, `~astropy.io.fits.ImageHDU`, `~astropy.io.fits.PrimaryHDU`, `~astropy.io.fits.HDUList`, `~specutils.Spectrum1D`, or ndarray
The path to a cube-like data FITS file or the data object to be loaded.
data_type : {'flux', 'uncert', 'mask', `None`}
The data type used to explicitly differentiate parsed data.
Expand Down

0 comments on commit 3db79bc

Please sign in to comment.