doc cleanup

Author: jchanvfx

NodeGraphQt/base/graph.py

@@ -41,7 +41,7 @@ class NodeGraph(QtCore.QObject):
     #: signal for when drop data has been added to the graph.
     data_dropped = QtCore.Signal(QtCore.QMimeData, QtCore.QPoint)
 
-    def __init__(self, parent=None, tab_search_key='tab'):
+    def __init__(self, parent=None):
         super(NodeGraph, self).__init__(parent)
         self.setObjectName('NodeGraphQt')
         self._model = NodeGraphModel()
@@ -53,7 +53,7 @@ def __init__(self, parent=None, tab_search_key='tab'):
         self._nodes_tree = None
 
         tab = QtWidgets.QAction('Search Nodes', self)
-        tab.setShortcut(tab_search_key)
+        tab.setShortcut('tab')
         tab.triggered.connect(self._toggle_tab_search)
         self._viewer.addAction(tab)
 

NodeGraphQt/base/node.py

@@ -30,7 +30,7 @@ class NodeObject(object):
     base class for all node objects.
 
     Args:
-        node (AbstractNodeItem): graphic item used for drawing.
+        qgraphics_item (AbstractNodeItem): graphic item used for drawing.
     """
 
     #: (str) unique node identifier domain.
@@ -39,13 +39,13 @@ class NodeObject(object):
     #: (str) base node name.
     NODE_NAME = None
 
-    def __init__(self, node=None):
-        assert node, 'node cannot be None.'
+    def __init__(self, qgraphics_item=None):
+        assert qgraphics_item, 'qgraphics item cannot be None.'
         self._graph = None
         self._model = NodeModel()
         self._model.type_ = self.type_
         self._model.name = self.NODE_NAME
-        self._view = node
+        self._view = qgraphics_item
         self._view.type_ = self.type_
         self._view.name = self.model.name
         self._view.id = self._model.id

docs/nodes.rst

@@ -28,10 +28,33 @@ BaseNode
 
 The ``NodeGraphQt.BaseNode`` class is the base class for nodes that allows port connections from one node to another.
 
-
 .. image:: _images/node.png
     :width: 250px
 
+code snippet.
+
+.. code-block:: python
+    :linenos:
+
+    from NodeGraphQt import BaseNode
+
+    class FooNode(BaseNode):
+
+        # unique node identifier domain.
+        __identifier__ = 'com.chantasticvfx'
+
+        # initial default node name.
+        NODE_NAME = 'Foo Node'
+
+        def __init__(self):
+            super(FooNode, self).__init__()
+
+            # create an input port.
+            self.add_input('in')
+
+            # create an output port.
+            self.add_output('out')
+
 ----
 
 .. autoclass:: NodeGraphQt.BaseNode

docs/overview.rst

@@ -48,10 +48,10 @@ example code:
     import sys
     from PySide2 import QtWidgets
 
-    from NodeGraphQt import NodeGraph, Node, setup_context_menu
+    from NodeGraphQt import NodeGraph, BaseNode, setup_context_menu
 
 
-    class FooNode(Node):
+    class FooNode(BaseNode):
 
         # unique node identifier domain.
         __identifier__ = 'com.chantasticvfx'

docs/widgets.rst

@@ -23,6 +23,7 @@ PropertiesBinWidget
 
 .. autoclass:: NodeGraphQt.widgets.properties_bin.PropertiesBinWidget
     :members:
+    :exclude-members: property_changed
 
 NodeTreeWidget
 ==============
@@ -44,4 +45,5 @@ NodeTreeWidget
 ----
 
 .. autoclass:: NodeGraphQt.widgets.node_tree.NodeTreeWidget
-    :members:
+    :members:
+    :exclude-members: mimeData, set_node_factory, property_changed