Cleanup after second pass through stellarphot.io documentation. #100
Conversation
There was a problem hiding this comment.
This is looking good. I think we only want the leading ~ when referring to stellarphot stuff. Looking at the numpydoc documentation for the first time in a long time it looks like we can maybe not use backticks around the arguments? That seems like it is maybe the case in their example. Probably not important though.
I stopped removing the ~ about halfway through. If you go the route of accepting suggestions, it is much easier to add them to a batch than to add them one by one.
| @@ -99,7 +99,7 @@ def make_checker(indicator_widget, value_widget): | |||
| Parameters | |||
| ---------- | |||
|
|
|||
| indicator_widget : MyCheck widget | |||
| indicator_widget : `~stellarphot.analysis.MyValid` widget | |||
There was a problem hiding this comment.
I'm not 100% sure we need the full package name in this case because the class is in the package. I.e. MyValid might work just fine.
Reading through https://numpydoc.readthedocs.io/en/latest/index.html now to try to see....and after reading the (genuinely useful) documentation I'm still not sure.
stellarphot/source_detection.py
Outdated
| sources | ||
| an astropy table of the positions of sources in the image. | ||
| If `find_fwhm` is ``True``, includes a column called ``FWHM``. | ||
| sources: `~astropy.table.Table` |
There was a problem hiding this comment.
| sources: `~astropy.table.Table` | |
| sources: `astropy.table.Table` |
| @@ -44,7 +44,7 @@ def seeing_plot(raw_radius, raw_counts, binned_radius, binned_counts, HWHM, | |||
| Returns | |||
| ------- | |||
|
|
|||
| `matplotlib.pyplot.figure` | |||
| `~matplotlib.pyplot.figure` | |||
There was a problem hiding this comment.
| `~matplotlib.pyplot.figure` | |
| `matplotlib.pyplot.figure` |
| @@ -46,9 +46,9 @@ def read_file(radec_file): | |||
| Returns | |||
| ------- | |||
|
|
|||
| `astropy.table.Table` | |||
| `~astropy.table.Table` | |||
There was a problem hiding this comment.
| `~astropy.table.Table` | |
| `astropy.table.Table` |
| Table with target information, including a | ||
| `astropy.coordinates.SkyCoord` column. | ||
| `~astropy.coordinates.SkyCoord` column. |
There was a problem hiding this comment.
| `~astropy.coordinates.SkyCoord` column. | |
| `astropy.coordinates.SkyCoord` column. |
Co-authored-by: Matt Craig <[email protected]>
Co-authored-by: Matt Craig <[email protected]>
|
I did push through a big set of edits removing the tildas from all the non stellarphot packages. That hopefully handled most of the issues. Will finish the rest next week. |
Co-authored-by: Matt Craig <[email protected]>
This is likely another "epic" pull request. After reviewing some of the class UMLs I was generating from the stellarphot code, I realized there were a litany of other issues with the docstrings that needed to be dealt with. Among these issues:
__init__.pyinitialization method for all classes, since it is a public method.In the process of performing this second review of the docstrings I found a few public methods with no docstring and tried to address that as well.