doc string clean up

Author: jchanvfx

NodeGraphQt/base/graph.py

@@ -2189,6 +2189,18 @@ def node(self):
         return self._node
 
     def delete_node(self, node, push_undo=True):
+        """
+        Remove the node from the node sub graph.
+
+        Note:
+            :class:`.PortInputNode` & :class:`.PortOutputNode` can't be deleted
+            as they are connected to a :class:`.Port` to remove these port nodes
+            see :meth:`BaseNode.delete_input`, :meth:`BaseNode.delete_output`.
+
+        Args:
+            node (NodeGraphQt.BaseNode): node object.
+            push_undo (bool): register the command to the undo stack. (default: True)
+        """
         port_nodes = self.get_input_port_nodes() + self.get_output_port_nodes()
         if node in port_nodes and node.parent_port is not None:
             # note: port nodes can only be deleted by deleting the parent

NodeGraphQt/nodes/base_node.py

@@ -351,8 +351,9 @@ def delete_input(self, port):
         Warnings:
             Undo is NOT supported for this function.
 
-            You can only delete ports if the node has "ports_removable"
-            enabled see :meth:`BaseNode.set_ports_removable`.
+            You can only delete ports if :meth:`BaseNode.port_deletion_allowed`
+            returns ``True`` otherwise a port error is raised see also
+            :meth:`BaseNode.set_port_deletion_allowed`.
 
         Args:
             port (str or int): port name or index.
@@ -380,8 +381,9 @@ def delete_output(self, port):
         Warnings:
             Undo is NOT supported for this function.
 
-            You can only delete ports if the node has "ports_removable"
-            enabled see :meth:`BaseNode.set_ports_removable`.
+            You can only delete ports if :meth:`BaseNode.port_deletion_allowed`
+            returns ``True`` otherwise a port error is raised see also
+            :meth:`BaseNode.set_port_deletion_allowed`.
 
         Args:
             port (str or int): port name or index.
@@ -407,7 +409,8 @@ def set_port_deletion_allowed(self, mode=False):
         Allow ports to be removable on this node.
 
         See Also:
-            :meth:`BaseNode.ports_removable`
+            :meth:`BaseNode.port_deletion_allowed` and
+            :meth:`BaseNode.set_ports`
 
         Args:
             mode (bool): true to allow.
@@ -419,7 +422,7 @@ def port_deletion_allowed(self):
         Return true if ports can be deleted on this node.
 
         See Also:
-            :meth:`BaseNode.set_ports_removable`
+            :meth:`BaseNode.set_port_deletion_allowed`
 
         Returns:
             bool: true if ports can be deleted.
@@ -432,7 +435,8 @@ def set_ports(self, port_data):
 
         Warnings:
             You can only use this function if the node has
-            "ports_removable" enabled see :meth:`BaseNode.set_ports_removable`
+            :meth:`BaseNode.port_deletion_allowed` is `True`
+            see :meth:`BaseNode.set_port_deletion_allowed`
 
         Hint:
             example snippet of port data.
@@ -446,15 +450,13 @@ def set_ports(self, port_data):
                             'name': 'input',
                             'multi_connection': True,
                             'display_name': 'Input',
-                            'data_type': 'NoneType',
                             'locked': False
                         }],
                     'output_ports':
                         [{
                             'name': 'output',
                             'multi_connection': True,
                             'display_name': 'Output',
-                            'data_type': 'NoneType',
                             'locked': False
                         }]
                 }
@@ -465,7 +467,7 @@ def set_ports(self, port_data):
         if not self.port_deletion_allowed():
             raise PortError(
                 'Ports cannot be set on this node because '
-                '"ports_removable" is not enabled on this node.')
+                '"set_port_deletion_allowed" is not enabled on this node.')
 
         for port in self._inputs:
             self._view.delete_input(port.view)
@@ -480,11 +482,13 @@ def set_ports(self, port_data):
 
         [self.add_input(name=port['name'],
                         multi_input=port['multi_connection'],
-                        display_name=port['display_name'])
+                        display_name=port['display_name'],
+                        locked=port.get('locked') or False)
          for port in port_data['input_ports']]
         [self.add_output(name=port['name'],
                          multi_output=port['multi_connection'],
-                         display_name=port['display_name'])
+                         display_name=port['display_name'],
+                         locked=port.get('locked') or False)
          for port in port_data['output_ports']]
         self.draw()
 

docs/graph.rst

@@ -20,4 +20,4 @@ SubGraph
 
 .. autoclass:: NodeGraphQt.SubGraph
     :members:
-    :exclude-members: delete_node, is_root, sub_graphs, widget
+    :exclude-members: is_root, sub_graphs, widget