Update docs on property aliases

Author: tony

tmuxp/server.py

@@ -145,11 +145,7 @@ def _list_sessions(self):
 
     @property
     def _sessions(self):
-        """Return list of the server's sessions as :py:obj:`dict`.
-
-        :rtype: list
-
-        """
+        """Property / alias to return :meth:`~._list_sessions`."""
 
         return self._list_sessions()
 
@@ -165,7 +161,7 @@ def list_sessions(self):
 
     @property
     def sessions(self):
-        """Return a :py:obj:`list` of the server's :class:`Session` objects."""
+        """Property / alias to return :meth:`~.list_sessions`."""
         return self.list_sessions()
     #: Alias of :attr:`sessions`.
     children = sessions

tmuxp/session.py

@@ -231,9 +231,10 @@ def _list_windows(self):
 
         return windows
 
-    #: Property of :meth:_list_windows()
     @property
     def _windows(self):
+        """Property / alias to return :meth:`~._list_windows`."""
+
         return self._list_windows()
 
     def list_windows(self):
@@ -250,7 +251,7 @@ def list_windows(self):
 
     @property
     def windows(self):
-        """Return a :py:obj:`list` of the server's :class:`Window` objects."""
+        """Property / alias to return :meth:`~.list_windows`."""
         return self.list_windows()
     #: Alias of :attr:`windows`.
     children = windows

tmuxp/window.py

@@ -382,11 +382,8 @@ def _list_panes(self):
 
     @property
     def _panes(self):
-        """Return list of the windows' panes as :py:obj:`dict`.
+        """Property / alias to return :meth:`~._list_panes`."""
 
-        :rtype: list
-
-        """
         return self._list_panes()
 
     def list_panes(self):
@@ -400,7 +397,7 @@ def list_panes(self):
 
     @property
     def panes(self):
-        """Return a :py:obj:`list` of the windows' :class:`Pane` objects."""
+        """Property / alias to return :meth:`~.list_panes`."""
         return self.list_panes()
     #: Alias of :attr:`panes`.
     children = panes