chore(relational attributes): Fix docstrings

Author: tony

libtmux/pane.py

@@ -27,7 +27,7 @@ class Pane(TmuxMappingObject, TmuxRelationalObject):
     ``Pane`` instances can send commands directly to a pane, or traverse
     between linked tmux objects.
 
-    Parameters
+    Attributes
     ----------
     window : :class:`Window`
 
@@ -49,14 +49,14 @@ class Pane(TmuxMappingObject, TmuxRelationalObject):
        Accessed April 1st, 2018.
     """
 
-    #: namespace used :class:`~libtmux.common.TmuxMappingObject`
     formatter_prefix = "pane_"
-    #: :class:`libtmux.window.Window` pane is linked to
+    """Namespace used for :class:`~libtmux.common.TmuxMappingObject`"""
     window: "Window"
-    #: :class:`libtmux.session.Session` pane is linked to
+    """:class:`libtmux.Window` pane is linked to"""
     session: "Session"
-    #: :class:`libtmux.server.Server` pane is linked to
+    """:class:`libtmux.Session` pane is linked to"""
     server: "Server"
+    """:class:`libtmux.Server` pane is linked to"""
 
     def __init__(self, window: "Window", **kwargs):
         self.window = window

libtmux/server.py

@@ -60,18 +60,18 @@ class Server(TmuxRelationalObject, EnvironmentMixin):
        Accessed April 1st, 2018.
     """
 
-    #: ``[-L socket-name]``
     socket_name = None
-    #: ``[-S socket-path]``
+    """Passthrough to ``[-L socket-name]``"""
     socket_path = None
-    #: ``[-f file]``
+    """Passthrough to ``[-S socket-path]``"""
     config_file = None
-    #: ``-2`` or ``-8``
+    """Passthrough to ``[-f file]``"""
     colors = None
-    #: unique child ID used by :class:`~libtmux.common.TmuxRelationalObject`
+    """``-2`` or ``-8``"""
     child_id_attribute = "session_id"
-    #: namespace used :class:`~libtmux.common.TmuxMappingObject`
+    """Unique child ID used by :class:`~libtmux.common.TmuxRelationalObject`"""
     formatter_prefix = "server_"
+    """Namespace used for :class:`~libtmux.common.TmuxMappingObject`"""
 
     def __init__(
         self,

libtmux/session.py

@@ -51,12 +51,12 @@ class Session(TmuxMappingObject, TmuxRelationalObject, EnvironmentMixin):
        https://man.openbsd.org/tmux.1#DESCRIPTION. Accessed April 1st, 2018.
     """
 
-    #: unique child ID key for :class:`~libtmux.common.TmuxRelationalObject`
     child_id_attribute = "window_id"
-    #: namespace used :class:`~libtmux.common.TmuxMappingObject`
+    """Unique child ID key for :class:`~libtmux.common.TmuxRelationalObject`"""
     formatter_prefix = "session_"
-    #: :class:`libtmux.server.Server` session is linked to
+    """Namespace used for :class:`~libtmux.common.TmuxMappingObject`"""
     server: "Server"
+    """:class:`libtmux.server.Server` session is linked to"""
 
     def __init__(self, server: "Server", **kwargs):
         EnvironmentMixin.__init__(self)

libtmux/window.py

@@ -45,14 +45,14 @@ class Window(TmuxMappingObject, TmuxRelationalObject):
        https://man.openbsd.org/tmux.1#DESCRIPTION. Accessed April 1st, 2018.
     """
 
-    #: unique child ID key for :class:`~libtmux.common.TmuxRelationalObject`
     child_id_attribute = "pane_id"
-    #: namespace used :class:`~libtmux.common.TmuxMappingObject`
+    """Unique child ID key for :class:`~libtmux.common.TmuxRelationalObject`"""
     formatter_prefix = "window_"
-    #: :class:`libtmux.server.Server` window is linked to
+    """Namespace used for :class:`~libtmux.common.TmuxMappingObject`"""
     server: "Server"
-    #: :class:`libtmux.session.Session` window is linked to
+    """:class:`libtmux.Server` window is linked to"""
     session: "Session"
+    """:class:`libtmux.Session` window is linked to"""
 
     def __init__(self, session: "Session", **kwargs):
         self.session = session