doc updates

Author: jchanvfx

NodeGraphQt/base/menu.py

@@ -16,7 +16,8 @@ def __init__(self, viewer, qmenu):
 
     def __repr__(self):
         cls_name = self.__class__.__name__
-        return 'NodeGraphQt.{}(\'{}\')'.format(cls_name, self.name())
+        return '<NodeGraphQt.{}(\'{}\') @ {}>'.format(
+            cls_name, self.name(), hex(id(self)))
 
     @property
     def qmenu(self):

NodeGraphQt/base/model.py

@@ -22,7 +22,8 @@ def __init__(self, node):
         self.connected_ports = defaultdict(list)
 
     def __repr__(self):
-        return '{}(\'{}\')'.format(self.__class__.__name__, self.name)
+        return '<{}(\'{}\') @ {}>'.format(
+            self.__class__.__name__, self.name, hex(id(self)))
 
     @property
     def to_dict(self):

NodeGraphQt/base/node.py

@@ -50,7 +50,8 @@ def __init__(self, node=None):
         self._view.id = self._model.id
 
     def __repr__(self):
-        return '{}(\'{}\')'.format(self.type_, self.NODE_NAME)
+        return '<{}(\'{}\') @ {}>'.format(
+            self.type_, self.NODE_NAME, hex(id(self)))
 
     @classproperty
     def type_(cls):

NodeGraphQt/base/port.py

@@ -7,7 +7,7 @@
 
 class Port(object):
     """
-    base class for a :class:`NodeGraphQt.Node` port.
+    base class for a node port.
 
     Args:
         node (NodeGraphQt.NodeObject): parent node.

NodeGraphQt/widgets/properties_bin.py

@@ -54,7 +54,7 @@ class PropertiesBinWidget(QtWidgets.QWidget):
     #: Signal emitted (node_id, prop_name, prop_value)
     property_changed = QtCore.Signal(str, str, object)
 
-    def __init__(self, parent=None,):
+    def __init__(self, parent=None):
         super(PropertiesBinWidget, self).__init__(parent)
         self.setWindowTitle('Properties Bin')
         self._prop_list = PropertiesList()
@@ -97,6 +97,15 @@ def limit(self):
         """
         return int(self._limit.value())
 
+    def set_limit(self, limit):
+        """
+        Set limit of nodes to display.
+
+        Args:
+            limit (int): node limit.
+        """
+        self._limit.setValue(limit)
+
     def add_node(self, node):
         """
         Add node to the properties bin.

docs/graph.rst

@@ -1,5 +1,5 @@
-Node Graph
-**********
+Graph
+*****
 
 **Inherited from:** :class:`PySide2.QtCore.QObject`
 

docs/menu.rst

@@ -1,7 +1,7 @@
-Menu & Commands
-***************
+Menus
+*****
 
-Here's a example where we a menu with the name "Foo" to the node graphs context menu.
+example adding "Foo" menu to the node graphs context menu.
 
 .. code-block:: python
     :linenos:
@@ -17,7 +17,7 @@ Here's a example where we a menu with the name "Foo" to the node graphs context
     # add a menu called "Foo".
     foo_menu = root_menu.add_menu('Foo')
 
-and here we add a menu command with the name "Bar" to the "Foo" menu that will execute the ``my_test()`` method.
+add "Bar" command to the "Foo" menu.
 
 .. code-block:: python
     :linenos:
@@ -30,15 +30,23 @@ and here we add a menu command with the name "Bar" to the "Foo" menu that will e
     # add "Bar" command to the "Foo" menu.
     foo_menu.add_command('Bar', my_test, 'Shift+t')
 
-Simple Setup
-============
-
-The ``NodeGraphQt`` module has a built in method that'll populate the node graphs context menu a few
-default menus and commands.
+Default Setup
+=============
 
 .. image:: _images/menu_hotkeys.png
     :width: 50%
 
+The ``NodeGraphQt.setup_context_menu`` has a built in function that'll populate the node graphs context menu a few
+default menus and commands.
+
+.. code-block:: python
+    :linenos:
+
+    from NodeGraphQt import NodeGraph, setup_context_menu
+
+    graph = NodeGraph()
+    setup_context_menu(graph)
+
 ----
 
 .. autofunction:: NodeGraphQt.setup_context_menu

docs/nodes.rst

@@ -9,21 +9,16 @@ Object
 
 The ``NodeObject`` class is the main base class that all nodes inherit from.
 
-----
-
-.. note::
-    These two attributes require reimplementing when subclassing any node object.
-
-.. autoattribute:: NodeGraphQt.NodeObject.__identifier__
-.. autoattribute:: NodeGraphQt.NodeObject.NODE_NAME
-
-
 ----
 
 .. autoclass:: NodeGraphQt.NodeObject
     :members:
     :exclude-members: model, NODE_NAME
 
+Attributes
+
+.. autoattribute:: NodeGraphQt.NodeObject.__identifier__
+.. autoattribute:: NodeGraphQt.NodeObject.NODE_NAME
 
 Node
 ====

docs/overview.rst

@@ -17,22 +17,19 @@ Navigation
 | Pan           | *Alt + LMB + Drag* or *MMB + Drag*           |
 +---------------+----------------------------------------------+
 
-Tab Search
-==========
+Search
+======
 
 .. image:: _images/node_search.png
     :width: 269px
 
 Node can be created with the tab node search widget.
 
-+-------------+--------+
-| action      | hotkey |
-+=============+========+
-| Show Search | *Tab*  |
-+-------------+--------+
-
-.. note::
-    To override the tab search widget hotkey see :class:`NodeGraphQt.NodeGraph` class for the tab_search_key argument.
++-------------------+--------+
+| action            | hotkey |
++===================+========+
+| Toggle Visibility | *Tab*  |
++-------------------+--------+
 
 
 Properties Bin
@@ -59,7 +56,7 @@ The NodeGraphQt has a ``setup_context_menu`` method that'll setup the node graph
 
 `(see line:32 in the example code below)`
 
-see also: :ref:`Menu & Commands`
+see also: :ref:`Menus`
 
 
 Example