doc updates

Author: jchanvfx

NodeGraphQt/base/graph.py

@@ -801,6 +801,11 @@ def layout_direction(self):
         """
         Return the current node graph layout direction.
 
+        `Implemented in` ``v0.3.0``
+
+        See Also:
+            :meth:`NodeGraph.set_layout_direction`
+
         Returns:
             int: layout direction.
         """
@@ -814,13 +819,20 @@ def set_layout_direction(self, direction):
 
         `Implemented in` ``v0.3.0``
 
+        See Also:
+            :meth:`NodeGraph.layout_direction`,
+            :meth:`NodeObject.set_layout_direction`
+
         Note:
-            By default node graph direction is set to "NODE_LAYOUT_HORIZONTAL".
+            By default node graph direction is set to horizontal.
 
             Node Graph Layout Types:
 
-            * :attr:`NodeGraphQt.constants.NODE_LAYOUT_HORIZONTAL`
-            * :attr:`NodeGraphQt.constants.NODE_LAYOUT_VERTICAL`
+            * :attr:`NodeGraphQt.constants.LayoutDirectionEnum.HORIZONTAL`
+            * :attr:`NodeGraphQt.constants.LayoutDirectionEnum.VERTICAL`
+
+        Warnings:
+            This function does not register to the undo stack.
 
         Args:
             direction (int): layout direction.
@@ -900,7 +912,7 @@ def register_node(self, node, alias=None):
         Register the node to the :meth:`NodeGraph.node_factory`
 
         Args:
-            node (_NodeGraphQt.NodeObject): node object.
+            node (NodeGraphQt.NodeObject): node object.
             alias (str): custom alias name for the node type.
         """
         self._node_factory.register_node(node, alias)

NodeGraphQt/base/node.py

@@ -463,7 +463,10 @@ def pos(self):
 
     def layout_direction(self):
         """
-        Returns the current node layout direction.
+        Returns layout direction for this node.
+
+        See Also:
+            :meth:`NodeObject.set_layout_direction`
 
         Returns:
             int: node layout direction.
@@ -472,11 +475,16 @@ def layout_direction(self):
 
     def set_layout_direction(self, value=0):
         """
-        Sets the node layout direction to either horizontal or vertical.
+        Sets the node layout direction to either horizontal or vertical on
+        the current node only.
 
         `Implemented in` ``v0.3.0``
 
-        Note:
+        See Also:
+            :meth:`NodeGraph.set_layout_direction`
+            :meth:`NodeObject.layout_direction`
+
+        Warnings:
             This function does not register to the undo stack.
 
         Args:

NodeGraphQt/nodes/base_node.py

@@ -74,11 +74,17 @@ def update_model(self):
 
     def set_layout_direction(self, value=0):
         """
-        Sets the node layout direction to either horizontal or vertical.
+        Sets the node layout direction to either horizontal or vertical on
+        the current node only.
 
         `Implemented in` ``v0.3.0``
 
-        Note:
+        See Also:
+            :meth:`NodeGraph.set_layout_direction`,
+            :meth:`NodeObject.layout_direction`
+
+
+        Warnings:
             This function does not register to the undo stack.
 
         Args:

docs/nodes/BaseNode.rst

@@ -3,4 +3,4 @@ BaseNode
 
 .. autoclass:: NodeGraphQt.BaseNode
     :members:
-    :exclude-members: update_model
+    :exclude-members: update_model, set_layout_direction