Minor revisions to wording and formatting for API block documentation

astropy · Oct 25, 2018 · 8a80201 · 8a80201
1 parent 0c8ecdb
commit 8a80201
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 14 deletions.
diff --git a/docs/psf_spec/background_estimator.rst b/docs/psf_spec/background_estimator.rst
@@ -1,8 +1,8 @@
 BackgroundEstimator
 ===================
 
-Existing code documented at
-https://photutils.readthedocs.io/en/stable/api/photutils.background.BackgroundBase.html
+Existing code documented `here 
+<https://photutils.readthedocs.io/en/stable/api/photutils.background.BackgroundBase.html>`_
 -- while the ``__call__`` function has no docstring, the ``calc_background``
 function is the actual block API. This function is used significantly through `photutils`
 and is heavily used within the PSF fitting process, so the documentation is summarized

diff --git a/docs/psf_spec/finder.rst b/docs/psf_spec/finder.rst
@@ -1,9 +1,9 @@
 ObjectFinder
 ============
 
-Existing code documented at
-https://photutils.readthedocs.io/en/stable/api/photutils.detection.StarFinderBase.html
-- see the ``find_stars`` function for the basic API. ``Finder`` is a relatively
+Existing code documented `here 
+<https://photutils.readthedocs.io/en/stable/api/photutils.detection.StarFinderBase.html>`_
+-- see the ``find_stars`` function for the basic API. ``Finder`` is a relatively
 independent routine in the PSF fitting process, and as such it is documented within its
 own documentation blocks, based on ``StarFinderBase``; it is documented here for
 completeness.

diff --git a/docs/psf_spec/group_maker.rst b/docs/psf_spec/group_maker.rst
@@ -1,13 +1,14 @@
 GroupMaker
 ==========
 
-Documented as the ``__call__`` method of ``GroupStarsBase`` - see
-https://photutils.readthedocs.io/en/stable/api/photutils.psf.groupstars.GroupStarsBase.html.
-The API for the group maker may be subject to change if ``group_stars`` requires changes
-to accommodate future revisions to the PSF fitting process -- primarily it would require
-updates if the PSF fitting is extended to include non-point sources and "scene maker"
-functionality. These large changes would subsequently require significant changes to the
-PSF fitting routines (e.g., ``IterativelySubtractedPSFPhotometry``) as a whole.
+Documented as the ``__call__`` method of ``GroupStarsBase`` -- see `here 
+<https://photutils.readthedocs.io/en/stable/api/photutils.psf.groupstars.GroupStarsBase.html>`_
+for more information. The API for the group maker may be subject to change if ``group_stars``
+requires changes to accommodate future revisions to the PSF fitting process -- primarily it
+would require updates if the PSF fitting is extended to include non-point sources and
+"scene maker" functionality. These large changes would subsequently require significant
+changes to the PSF fitting routines (e.g., `~photutils.psf.IterativelySubtractedPSFPhotometry`)
+as a whole.
 
 A function which groups stars within some critical separation, returning potentially
 overlapping sources with an additonal column indicating their common group members.
@@ -64,7 +65,7 @@ Example Usage
 -------------
 
 Here we create a ``DAOGroup`` list of overlapping sources, then find all sources within 3 pixels
-of the first source in the list.::
+of the first source in the list. ::
 
     from photutils.psf.groupstars import DAOGroup
     group = DAOGroup(starlist, crit_separation=3)

diff --git a/docs/psf_spec/psf_model.rst b/docs/psf_spec/psf_model.rst
@@ -1,4 +1,4 @@
-PsfModel
+PSFModel
 ========
 
 The model for the PSF -- integrated over discrete pixels (see `discussion