fix #301 : updated api.rst to display also instance attributes (not p…

…ossible with Sphinx)
larray-project · Jun 13, 2017 · a402f3b · a402f3b
1 parent 40cadc6
commit a402f3b
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 3 deletions.
diff --git a/doc/source/api.rst b/doc/source/api.rst
@@ -13,11 +13,23 @@ Axis
 
    Axis
 
+Exploring
+---------
+
+=========================== ==============================================================
+Axis.name                   Name of the axis. None in the case of an anonymous axis.
+--------------------------- --------------------------------------------------------------
+:attr:`Axis.labels`         Labels of the axis.
+--------------------------- --------------------------------------------------------------
+:attr:`Axis.labels_summary` Short representation of the labels.
+=========================== ==============================================================
+
+Copying
+-------
+
 .. autosummary::
    :toctree: _generated/
 
-   Axis.labels
-   Axis.labels_summary
    Axis.copy
 
 Searching
@@ -227,6 +239,14 @@ Copying
 Inspecting
 ----------
 
+=================== ==============================================================
+LArray.data         Data of the array (Numpy ndarray)
+------------------- --------------------------------------------------------------
+LArray.axes         Axes of the array (AxisCollection)
+------------------- --------------------------------------------------------------
+LArray.title        Title of the array (str)
+=================== ==============================================================
+
 .. autosummary::
    :toctree: _generated/
 

diff --git a/larray/core/axis.py b/larray/core/axis.py
@@ -177,7 +177,7 @@ def i(self):
     @property
     def labels(self):
         """
-        List of labels.
+        labels of the axis.
         """
         return self._labels