basic code example and links to Spectrum1D.write #1017
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1017 +/- ##
=======================================
Coverage 70.03% 70.03%
=======================================
Files 64 64
Lines 4339 4339
=======================================
Hits 3039 3039
Misses 1300 1300 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
docs/spectrum1d.rst
Outdated
| ----------------- | ||
|
|
||
| Similarly, a `~specutils.Spectrum1D` object can be saved to any file format supported by | ||
| :class:`~astropy.nddata.CCDData` via the :meth:`specutils.Spectrum1D.write` method. |
There was a problem hiding this comment.
Why is CCDData involved here?
specutils/specutils/spectra/spectrum1d.py
Line 20 in 25cb121
There was a problem hiding this comment.
It comes from NDIOMixin whose API docs state CCDData 🤷
There was a problem hiding this comment.
I think NDIOMixin used CCDData as an example of implementation using the mixin. I don't think specutils has anything to do with CCDData.
There was a problem hiding this comment.
ok, would you rather that I just point directly to NDIOMixin then, or nothing at all and just leave the link to the API docs which inherits from NDIOMixin API?
There was a problem hiding this comment.
Why not link to https://specutils.readthedocs.io/en/latest/spectrum1d.html#reading-from-a-file (with ref)? (The table has a "write" column.)
There was a problem hiding this comment.
that is immediately before this sub-section, so I'll just update the text to mention "supported formats".
docs/spectrum1d.rst
Outdated
| >>> from specutils import Spectrum1D | ||
| >>> spec1d = Spectrum1D.read("/path/to/input.fits") # doctest: +SKIP |
There was a problem hiding this comment.
Do we really need this? Reading is already covered in https://specutils.readthedocs.io/en/stable/spectrum1d.html#reading-from-a-file
| >>> from specutils import Spectrum1D | |
| >>> spec1d = Spectrum1D.read("/path/to/input.fits") # doctest: +SKIP |
There was a problem hiding this comment.
Should the snippets be somewhat standalone or is it ok to assume at this point that the user already has a spectrum1D object loaded/created?
There was a problem hiding this comment.
Depends on who you ask. 😆
You can ref back to the "reading" section if you want, but I think it is overkill to tell people how to read again.
|
Maybe also want to link to https://specutils.readthedocs.io/en/stable/custom_loading.html#creating-a-custom-writer (using ref)? |
kecnry
force-pushed
the
docs-spectrum1d-write
branch
from
15791c1 to
c7e657a
Compare
kecnry
force-pushed
the
docs-spectrum1d-write
branch
from
c7e657a to
19c8923
Compare
kecnry
force-pushed
the
docs-spectrum1d-write
branch
from
19c8923 to
bded1d7
Compare
This PR adds a very brief example of how to use
Spectrum1D.writeand links to the API docs within the main spectrum1d landing page on the docs.See rendered docs from this PR