doc formatting updates

Author: jchanvfx

NodeGraphQt/base/graph.py

@@ -823,7 +823,7 @@ def registered_nodes(self):
         """
         Return a list of all node types that have been registered.
 
-        See Also:
+        Hint:
             To register a node :meth:`NodeGraph.register_node`
 
         Returns:

NodeGraphQt/base/node.py

@@ -628,7 +628,7 @@ def add_combo_menu(self, name, label='', items=None, tab=None):
         function and embeds a :class:`PySide2.QtWidgets.QComboBox` widget
         into the node.
 
-        Note:
+        Important:
             The embedded widget is wired up to the :meth:`NodeObject.set_property`
             function use this function to to update the widget.
 
@@ -652,7 +652,7 @@ def add_text_input(self, name, label='', text='', tab=None, multi_line=False):
         function and embeds a :class:`PySide2.QtWidgets.QLineEdit` widget
         into the node.
 
-        Note:
+        Important:
             The embedded widget is wired up to the :meth:`NodeObject.set_property`
             function use this function to to update the widget.
 
@@ -677,7 +677,7 @@ def add_file_input(self, name, label='', text='', tab=None, ext="*"):
         function and embeds a :class:`PySide2.QtWidgets.QLineEdit` widget
         into the node.
 
-        Note:
+        Important:
             The embedded widget is wired up to the :meth:`NodeObject.set_property`
             function use this function to to update the widget.
 
@@ -700,7 +700,7 @@ def add_float_input(self, name, label='', value=0.0, range=None, tab=None):
         function and embeds a :class:`PySide2.QtWidgets.QLineEdit` widget
         into the node.
 
-        Note:
+        Important:
             The embedded widget is wired up to the :meth:`NodeObject.set_property`
             function use this function to to update the widget.
 
@@ -723,7 +723,7 @@ def add_int_input(self, name, label='', value=0, range=None, tab=None):
         function and embeds a :class:`PySide2.QtWidgets.QLineEdit` widget
         into the node.
 
-        Note:
+        Important:
             The embedded widget is wired up to the :meth:`NodeObject.set_property`
             function use this function to to update the widget.
 
@@ -746,7 +746,7 @@ def add_checkbox(self, name, label='', text='', state=False, tab=None):
         function and embeds a :class:`PySide2.QtWidgets.QCheckBox` widget
         into the node.
 
-        Note:
+        Important:
             The embedded widget is wired up to the :meth:`NodeObject.set_property`
             function use this function to to update the widget.
 

NodeGraphQt/widgets/viewer.py

@@ -112,8 +112,8 @@ def __init__(self, parent=None):
         self.COLLIDING_state = False
 
     def __repr__(self):
-        return '{}.{}()'.format(
-            self.__module__, self.__class__.__name__)
+        return '<{}() object at {}>'.format(
+            self.__class__.__name__, hex(id(self)))
 
     # --- private ---
 

docs/nodes/NodeObject.rst

@@ -10,19 +10,19 @@ NodeObject
 
         Initial base node name.
 
-        .. note:: re-implement this attribute to provide a base node name.
+        .. important:: re-implement this attribute to provide a base node name.
 
         :return: node name
         :rtype: str
 
     .. autoattribute:: __identifier__
         :annotation:
 
-        Unique node identifier domain. eg. ``"com.chantacticvfx"``
+        Unique node identifier domain. eg. ``"nodeGraphQt.nodes"``
 
-        .. note:: re-implement this attribute to provide a unique node type.
+        .. important:: re-implement this attribute to provide a unique node type.
 
-        :return: node identifer domain
+        :return: node identifier domain
         :rtype: str
 
     .. autoattribute:: graph
@@ -31,7 +31,7 @@ NodeObject
     .. autoattribute:: type_
         :annotation:
 
-        Node type identifier followed by the class name. `eg.` ``"com.chantacticvfx.NodeObject"``
+        Node type identifier followed by the class name (<identifier>.<class_name>). `eg.` ``"nodeGraphQt.nodes.NodeObject"``
 
         :return: node type (``__identifier__.__className__``)
         :rtype: str