doc clean up

jchanvfx · jchanvfx · commit fed59b8d9b2a · 2020-01-03T00:17:06.000+13:00
diff --git a/NodeGraphQt/base/graph.py b/NodeGraphQt/base/graph.py
@@ -265,8 +265,8 @@ def viewer(self):
         Returns the view interface used by the node graph.
 
         Warnings:
-            Methods in the `NodeViewer` are used internally
-            by `NodeGraphQt` components.
+            Methods in the ``NodeViewer`` are used internally
+            by ``NodeGraphQt`` components.
 
         See Also:
             :attr:`NodeGraph.widget` for adding the node graph into a 
@@ -279,7 +279,7 @@ def viewer(self):
 
     def scene(self):
         """
-        Return the scene object.
+        Returns the ``QGraphicsScene`` object used in the node graph.
 
         Returns:
             NodeGraphQt.widgets.scene.NodeScene: node scene.
@@ -421,9 +421,9 @@ def get_context_menu(self, menu):
         """
         Returns the context menu specified by the name.
 
-        Menu types:
-            "graph" - context menu from the node graph.
-            "nodes" - context menu for the nodes.
+        Menu Types:
+            - ``"graph"`` context menu from the node graph.
+            - ``"nodes"`` context menu for the nodes.
 
         Args:
             menu (str): menu name.
@@ -466,13 +466,13 @@ def acyclic(self):
         Returns true if the current node graph is acyclic.
 
         Returns:
-            bool: true if acyclic (default: True).
+            bool: true if acyclic (default: ``True``).
         """
         return self._model.acyclic
 
     def set_acyclic(self, mode=False):
         """
-        Enable the node graph to be a acyclic graph. (default=False)
+        Enable the node graph to be a acyclic graph. (default: ``False``)
 
         Args:
             mode (bool): true to enable acyclic.
@@ -520,10 +520,10 @@ def reset_zoom(self):
 
     def set_zoom(self, zoom=0):
         """
-        Set the zoom factor of the Node Graph the default is 0.0
+        Set the zoom factor of the Node Graph the default is ``0.0``
 
         Args:
-            zoom (float): zoom factor (max zoom out -0.9 / max zoom in 2.0)
+            zoom (float): zoom factor (max zoom out ``-0.9`` / max zoom in ``2.0``)
         """
         self._viewer.set_zoom(zoom)
 
@@ -586,9 +586,9 @@ def create_node(self, node_type, name=None, selected=True, color=None,
             node_type (str): node instance type.
             name (str): set name of the node.
             selected (bool): set created node to be selected.
-            color (tuple or str): node color (255, 255, 255) or '#FFFFFF'.
-            text_color (tuple or str): node text color (255, 255, 255) or '#FFFFFF'.
-            pos (list[int, int]): initial x, y position for the node (default: (0, 0)).
+            color (tuple or str): node color ``(255, 255, 255)`` or ``"#FFFFFF"``.
+            text_color (tuple or str): text color ``(255, 255, 255)`` or ``"#FFFFFF"``.
+            pos (list[int, int]): initial x, y position for the node (default: ``(0, 0)``).
 
         Returns:
             NodeGraphQt.BaseNode: the created instance of the node.
@@ -734,7 +734,7 @@ def get_node_by_id(self, node_id=None):
         Returns the node from the node id string.
 
         Args:
-            node_id (str): node id (:meth:`NodeObject.id`)
+            node_id (str): node id (:attr:`NodeObject.id`)
 
         Returns:
             NodeGraphQt.NodeObject: node object.
@@ -1053,7 +1053,7 @@ def disable_nodes(self, nodes, mode=None):
 
     def question_dialog(self, text, title='Node Graph'):
         """
-        Prompts a question open dialog with "Yes" and "No" buttons in
+        Prompts a question open dialog with ``"Yes"`` and ``"No"`` buttons in
         the node graph.
 
         Note:
@@ -1093,7 +1093,7 @@ def load_dialog(self, current_dir=None, ext=None):
 
         Args:
             current_dir (str): path to a directory.
-            ext (str): custom file type extension (default: json)
+            ext (str): custom file type extension (default: ``"json"``)
 
         Returns:
             str: selected file path.
@@ -1110,7 +1110,7 @@ def save_dialog(self, current_dir=None, ext=None):
 
         Args:
             current_dir (str): path to a directory.
-            ext (str): custom file type extension (default: json)
+            ext (str): custom file type extension (default: ``"json"``)
 
         Returns:
             str: selected file path.
diff --git a/NodeGraphQt/base/node.py b/NodeGraphQt/base/node.py
@@ -174,7 +174,7 @@ def color(self):
         Returns the node color in (red, green, blue) value.
 
         Returns:
-            tuple: (r, g, b) from 0-255 range.
+            tuple: ``(r, g, b)`` from ``0-255`` range.
         """
         r, g, b, a = self.model.color
         return r, g, b
@@ -184,9 +184,9 @@ def set_color(self, r=0, g=0, b=0):
         Sets the color of the node in (red, green, blue) value.
 
         Args:
-            r (int): red value 0-255 range.
-            g (int): green value 0-255 range.
-            b (int): blue value 0-255 range.
+            r (int): red value ``0-255`` range.
+            g (int): green value ``0-255`` range.
+            b (int): blue value ``0-255`` range.
         """
         self.set_property('color', (r, g, b, 255))
 
@@ -195,7 +195,7 @@ def disabled(self):
         Returns weather the node is enabled or disabled.
 
         Returns:
-            bool: true if the node is disabled.
+            bool: True if the node is disabled.
         """
         return self.model.disabled
 
@@ -204,7 +204,7 @@ def set_disabled(self, mode=False):
         Set the node state to either disabled or enabled.
 
         Args:
-            mode(bool): true to disable node.
+            mode(bool): True to disable node.
         """
         self.set_property('disabled', mode)
 
@@ -235,8 +235,8 @@ def create_property(self, name, value, items=None, range=None,
         Args:
             name (str): name of the property.
             value (object): data.
-            items (list[str]): items used by widget type NODE_PROP_QCOMBO
-            range (tuple)): min, max values used by NODE_PROP_SLIDER
+            items (list[str]): items used by widget type ``NODE_PROP_QCOMBO``
+            range (tuple)): ``(min, max)`` values used by ``NODE_PROP_SLIDER``
             widget_type (int): widget flag to display in the properties bin.
             tab (str): name of the widget tab to display in the properties bin.
         """
@@ -502,7 +502,7 @@ def add_input(self, name='input', multi_input=False, display_name=True,
             name (str): name for the input port.
             multi_input (bool): allow port to have more than one connection.
             display_name (bool): display the port name on the node.
-            color (tuple): initial port color (r, g, b) 0-255.
+            color (tuple): initial port color (r, g, b) ``0-255``.
 
         Returns:
             NodeGraphQt.Port: the created port object.
@@ -532,7 +532,7 @@ def add_output(self, name='output', multi_output=True, display_name=True,
             name (str): name for the output port.
             multi_output (bool): allow port to have more than one connection.
             display_name (bool): display the port name on the node.
-            color (tuple): initial port color (r, g, b) 0-255.
+            color (tuple): initial port color (r, g, b) ``0-255``.
 
         Returns:
             NodeGraphQt.Port: the created port object.
diff --git a/NodeGraphQt/base/port.py b/NodeGraphQt/base/port.py
@@ -52,8 +52,12 @@ def type_(self):
         """
         Returns the port type.
 
+        Port Types:
+            - :attr:`NodeGraphQt.constants.IN_PORT` for input port
+            - :attr:`NodeGraphQt.constants.OUT_PORT` for output port
+
         Returns:
-            str: 'in' for input port or 'out' for output port.
+            str: port connection type.
         """
         return self.model.type_
 
@@ -132,8 +136,8 @@ def connected_ports(self):
 
     def connect_to(self, port=None):
         """
-        Create connection to the specified port and emits the "port_connected"
-        signal from the parent node graph.
+        Create connection to the specified port and emits the
+        :attr:`NodeGraph.port_connected` signal from the parent node graph.
 
         Args:
             port (NodeGraphQt.Port): port object.
@@ -184,8 +188,8 @@ def connect_to(self, port=None):
 
     def disconnect_from(self, port=None):
         """
-        Disconnect from the specified port and emits the "port_disconnected"
-        signal from the parent node graph.
+        Disconnect from the specified port and emits the
+        :attr:`NodeGraph.port_disconnected` signal from the parent node graph.
 
         Args:
             port (NodeGraphQt.Port): port object.
