Skip to content

Commit b45d6fc

Browse files
committed
doc string update
1 parent b8a1ea1 commit b45d6fc

File tree

7 files changed

+21
-0
lines changed

7 files changed

+21
-0
lines changed

NodeGraphQt/nodes/base_node.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,9 @@ def add_input(self, name='input', multi_input=False, display_name=True,
232232
"""
233233
Add input :class:`Port` to node.
234234
235+
Warnings:
236+
Undo is NOT supported for this function.
237+
235238
Args:
236239
name (str): name for the input port.
237240
multi_input (bool): allow port to have more than one connection.
@@ -272,6 +275,9 @@ def add_output(self, name='output', multi_output=True, display_name=True,
272275
"""
273276
Add output :class:`Port` to node.
274277
278+
Warnings:
279+
Undo is NOT supported for this function.
280+
275281
Args:
276282
name (str): name for the output port.
277283
multi_output (bool): allow port to have more than one connection.
@@ -343,6 +349,8 @@ def delete_input(self, port):
343349
Delete input port.
344350
345351
Warnings:
352+
Undo is NOT supported for this function.
353+
346354
You can only delete ports if the node has "ports_removable"
347355
enabled see :meth:`BaseNode.set_ports_removable`.
348356
@@ -370,6 +378,8 @@ def delete_output(self, port):
370378
Delete output port.
371379
372380
Warnings:
381+
Undo is NOT supported for this function.
382+
373383
You can only delete ports if the node has "ports_removable"
374384
enabled see :meth:`BaseNode.set_ports_removable`.
375385

docs/_images/group_node.png

47.8 KB
Loading

docs/_images/port_in_node.png

9.38 KB
Loading

docs/_images/port_out_node.png

9.98 KB
Loading

docs/_images/screenshot.png

-22.3 KB
Loading

docs/nodes/GroupNode.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
BackdropNode
2+
############
3+
4+
.. autoclass:: NodeGraphQt.BackdropNode
5+
:members:

docs/nodes/PortNode.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
GroupNode
2+
#########
3+
4+
.. autoclass:: NodeGraphQt.GroupNode
5+
:members:
6+
:exclude-members: add_input, add_output, delete_input, delete_output

0 commit comments

Comments
 (0)