Spruce up formatter_prefix, child_id_attr docs, mixin docs

Author: tony

libtmux/common.py

@@ -202,6 +202,14 @@ class TmuxMappingObject(collections.MutableMapping):
     Session, Window, Pane, stored :attr:`self._info`. For example, a
     :class:`Window` will have a ``window_id`` and ``window_name``.
 
+    ================ ================================== ==============
+    Object           formatter_prefix                   value
+    ================ ================================== ==============
+    :class:`Server`  n/a                                n/a
+    :class:`Session` :attr:`Session.formatter_prefix`   session\_
+    :class:`Window`  :attr:`Window.formatter_prefix`    window\_
+    :class:`Pane`    :attr:`Pane.formatter_prefix`      pane\_
+    ================ ================================== ==============
     """
 
     def __getitem__(self, key):
@@ -242,24 +250,24 @@ class TmuxRelationalObject(object):
     :class:`Window`)
 
     Children of :class:`TmuxRelationalObject` are going to have a
-    ``self.children``, ``self.child_id_attribute`` and ``self.list_children``.
+    ``self.children``, ``self.child_id_attribute``.
 
-    ================ ======================== ==================================
-    Object           .children                method
-    ================ ======================== ==================================
-    :class:`Server`  :attr:`Server._sessions` :meth:`Server.list_sessions`
-    :class:`Session` :attr:`Windows._windows` :meth:`Session.list_windows`
-    :class:`Window`  :attr:`Panes._panes`     :meth:`Window.list_panes`
-    :class:`Pane`
-    ================ ======================== ==================================
+    ================ ========================= =================================
+    Object           .children                 method
+    ================ ========================= =================================
+    :class:`Server`  :attr:`Server._sessions`  :meth:`Server.list_sessions`
+    :class:`Session` :attr:`Sessions._windows` :meth:`Session.list_windows`
+    :class:`Window`  :attr:`Windows._panes`    :meth:`Window.list_panes`
+    :class:`Pane`    n/a                       n/a
+    ================ ========================= =================================
 
     ================ ================================== ==============
     Object           child_id_attribute                 value
     ================ ================================== ==============
-    :class:`Server`  :attr:`Server.child_id_attribute`` ``session_id``
-    :class:`Session` :attr:`Session.window_id`          ``window_id``
-    :class:`Window`  :attr:`Window.pane_id`             ``pane_id``
-    :class:`Pane`
+    :class:`Server`  :attr:`Server.child_id_attribute`  session_id
+    :class:`Session` :attr:`Session.child_id_attribute` window_id
+    :class:`Window`  :attr:`Window.child_id_attribute`  pane_id
+    :class:`Pane`    n/a                                n/a
     ================ ================================== ==============
     """
 

libtmux/pane.py

@@ -24,8 +24,8 @@ class Pane(TmuxMappingObject, TmuxRelationalObject):
 
     :versionchanged: 0.8
         Renamed from ``.tmux`` to ``.cmd``.
-
     """
+    #: namespace used :class:`TmuxMappingObject`
     formatter_prefix = 'pane_'
 
     def __init__(self, window=None, **kwargs):

libtmux/server.py

@@ -43,9 +43,9 @@ class Server(TmuxRelationalObject, EnvironmentMixin):
     config_file = None
     #: ``-2`` or ``-8``
     colors = None
-    #: unique child ID key
+    #: unique child ID key used by :class:`TmuxRelationalObject`
     child_id_attribute = 'session_id'
-    #: namespace used by tmux formatter variables
+    #: namespace used :class:`TmuxMappingObject`
     formatter_prefix = 'server_'
 
     def __init__(
@@ -162,7 +162,7 @@ def list_sessions(self):
     def sessions(self):
         """Property / alias to return :meth:`~.list_sessions`."""
         return self.list_sessions()
-    #: Alias of :attr:`sessions`.
+    #: Alias of :attr:`sessions`, , used by :class:`TmuxRelationalObject`
     children = sessions
 
     def _list_windows(self):

libtmux/session.py

@@ -26,10 +26,11 @@ class Session(
     """:term:`tmux(1)` session.
 
     Holds :class:`Window` objects.
-
     """
 
+    #: unique child ID key used by :class:`TmuxRelationalObject`
     child_id_attribute = 'window_id'
+    #: namespace used :class:`TmuxMappingObject`
     formatter_prefix = 'session_'
 
     def __init__(self, server=None, **kwargs):
@@ -268,7 +269,7 @@ def windows(self):
         """Property / alias to return :meth:`~.list_windows`."""
         return self.list_windows()
 
-    #: Alias of :attr:`windows`.
+    #: Alias of :attr:`windows`, used by :class:`TmuxRelationalObject`
     children = windows
 
     @property

libtmux/window.py

@@ -21,7 +21,9 @@
 class Window(TmuxMappingObject, TmuxRelationalObject):
     """:term:`tmux(1)` window."""
 
+    #: unique child ID key used by :class:`TmuxRelationalObject`
     child_id_attribute = 'pane_id'
+    #: namespace used :class:`TmuxMappingObject`
     formatter_prefix = 'window_'
 
     def __init__(self, session=None, **kwargs):
@@ -463,5 +465,5 @@ def panes(self):
         """Property / alias to return :meth:`~.list_panes`."""
         return self.list_panes()
 
-    #: Alias of :attr:`panes`.
+    #: Alias of :attr:`panes`, used by :class:`TmuxRelationalObject`
     children = panes