Improvements to documentation

astropy/wcs/wcsapi/fitswcs.py

@@ -63,8 +63,8 @@
 
 class FITSWCSAPIMixin(BaseLowLevelWCS, HighLevelWCSMixin):
     """
-    A wrapper around the :class:`astropy.wcs.WCS` class that provides the
-    low-level WCS API from APE 14.
+    A mix-in class that is intended to be inherited by the
+    :class:`~astropy.wcs.WCS` class and provides the low- and high-level WCS API
     """
 
     @property

astropy/wcs/wcsapi/high_level_api.py

@@ -44,6 +44,12 @@ def default_order(components):
 
 
 class BaseHighLevelWCS(metaclass=abc.ABCMeta):
+    """
+    Abstract base class for the high-level WCS interface.
+
+    This is described in `APE 14: A shared Python interface for World Coordinate
+    Systems <https://doi.org/10.5281/zenodo.1188875>`_.
+    """
 
     @property
     @abc.abstractmethod
@@ -100,8 +106,8 @@ def world_to_array_index(self, *world_objects):
 
 class HighLevelWCSMixin(BaseHighLevelWCS):
     """
-    This is a mix-in class that automatically provides the high-level WCS API
-    for the low-level WCS object given by the `~HighLevelWCSMixin.low_level_wcs`
+    Mix-in class that automatically provides the high-level WCS API for the
+    low-level WCS object given by the `~HighLevelWCSMixin.low_level_wcs`
     property.
     """
 

astropy/wcs/wcsapi/high_level_wcs_wrapper.py

@@ -4,6 +4,10 @@
 
 
 class HighLevelWCSWrapper(HighLevelWCSMixin):
+    """
+    Wrapper class that can take any `BaseLowLevelWCS` object and expose the
+    high-level WCS API.
+    """
 
     def __init__(self, low_level_wcs):
         self._low_level_wcs = low_level_wcs

docs/wcs/wcsapi.rst

@@ -28,3 +28,5 @@ Reference/API
 =============
 
 .. automodapi:: astropy.wcs.wcsapi
+
+.. automodapi:: astropy.wcs.wcsapi.fitswcs