Skip to content

Commit bb30186

Browse files
committed
doc string clean up
1 parent 5a1ab86 commit bb30186

File tree

1 file changed

+38
-10
lines changed

1 file changed

+38
-10
lines changed

NodeGraphQt/base/graph.py

Lines changed: 38 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -648,7 +648,7 @@ def context_menu(self):
648648
649649
Note:
650650
This is a convenience function to
651-
:meth:`NodeGraphQt.NodeGraph.get_context_menu`
651+
:meth:`NodeGraph.get_context_menu`
652652
with the arg ``menu="graph"``
653653
654654
Returns:
@@ -662,7 +662,7 @@ def context_nodes_menu(self):
662662
663663
Note:
664664
This is a convenience function to
665-
:meth:`NodeGraphQt.NodeGraph.get_context_menu`
665+
:meth:`NodeGraph.get_context_menu`
666666
with the arg ``menu="nodes"``
667667
668668
Returns:
@@ -719,7 +719,7 @@ def acyclic(self):
719719
Returns true if the current node graph is acyclic.
720720
721721
See Also:
722-
:meth:`NodeGraphQt.NodeGraph.set_acyclic`
722+
:meth:`NodeGraph.set_acyclic`
723723
724724
Returns:
725725
bool: true if acyclic (default: ``True``).
@@ -731,7 +731,7 @@ def set_acyclic(self, mode=False):
731731
Enable the node graph to be a acyclic graph. (default: ``False``)
732732
733733
See Also:
734-
:meth:`NodeGraphQt.NodeGraph.acyclic`
734+
:meth:`NodeGraph.acyclic`
735735
736736
Args:
737737
mode (bool): true to enable acyclic.
@@ -1333,6 +1333,11 @@ def serialize_session(self):
13331333
"""
13341334
Serializes the current node graph layout to a dictionary.
13351335
1336+
See Also:
1337+
:meth:`NodeGraph.deserialize_session`,
1338+
:meth:`NodeGraph.save_session`,
1339+
:meth:`NodeGraph.load_session`
1340+
13361341
Returns:
13371342
dict: serialized session of the current node layout.
13381343
"""
@@ -1342,6 +1347,11 @@ def deserialize_session(self, layout_data):
13421347
"""
13431348
Load node graph session from a dictionary object.
13441349
1350+
See Also:
1351+
:meth:`NodeGraph.serialize_session`,
1352+
:meth:`NodeGraph.load_session`,
1353+
:meth:`NodeGraph.save_session`
1354+
13451355
Args:
13461356
layout_data (dict): dictionary object containing a node session.
13471357
"""
@@ -1353,6 +1363,11 @@ def save_session(self, file_path):
13531363
"""
13541364
Saves the current node graph session layout to a `JSON` formatted file.
13551365
1366+
See Also:
1367+
:meth:`NodeGraph.serialize_session`,
1368+
:meth:`NodeGraph.deserialize_session`,
1369+
:meth:`NodeGraph.load_session`,
1370+
13561371
Args:
13571372
file_path (str): path to the saved node layout.
13581373
"""
@@ -1384,6 +1399,11 @@ def load_session(self, file_path):
13841399
"""
13851400
Load node graph session layout file.
13861401
1402+
See Also:
1403+
:meth:`NodeGraph.deserialize_session`,
1404+
:meth:`NodeGraph.serialize_session`,
1405+
:meth:`NodeGraph.save_session`
1406+
13871407
Args:
13881408
file_path (str): path to the serialized layout file.
13891409
"""
@@ -1429,8 +1449,12 @@ def copy_nodes(self, nodes=None):
14291449
"""
14301450
Copy nodes to the clipboard.
14311451
1452+
See Also:
1453+
:meth:`NodeGraph.cut_nodes`
1454+
14321455
Args:
1433-
nodes (list[NodeGraphQt.BaseNode]): list of nodes (default: selected nodes).
1456+
nodes (list[NodeGraphQt.BaseNode]):
1457+
list of nodes (default: selected nodes).
14341458
"""
14351459
nodes = nodes or self.selected_nodes()
14361460
if not nodes:
@@ -1447,8 +1471,12 @@ def cut_nodes(self, nodes=None):
14471471
"""
14481472
Cut nodes to the clipboard.
14491473
1474+
See Also:
1475+
:meth:`NodeGraph.copy_nodes`
1476+
14501477
Args:
1451-
nodes (list[NodeGraphQt.BaseNode]): list of nodes (default: selected nodes).
1478+
nodes (list[NodeGraphQt.BaseNode]):
1479+
list of nodes (default: selected nodes).
14521480
"""
14531481
self._undo_stack.beginMacro('cut nodes')
14541482
nodes = nodes or self.selected_nodes()
@@ -1531,7 +1559,7 @@ def question_dialog(self, text, title='Node Graph'):
15311559
15321560
Note:
15331561
Convenience function to
1534-
:meth:`NodeGraphQt.NodeGraph.viewer().question_dialog`
1562+
:meth:`NodeGraph.viewer().question_dialog`
15351563
15361564
Args:
15371565
text (str): question text.
@@ -1548,7 +1576,7 @@ def message_dialog(self, text, title='Node Graph'):
15481576
15491577
Note:
15501578
Convenience function to
1551-
:meth:`NodeGraphQt.NodeGraph.viewer().message_dialog`
1579+
:meth:`NodeGraph.viewer().message_dialog`
15521580
15531581
Args:
15541582
text (str): message text.
@@ -1562,7 +1590,7 @@ def load_dialog(self, current_dir=None, ext=None):
15621590
15631591
Note:
15641592
Convenience function to
1565-
:meth:`NodeGraphQt.NodeGraph.viewer().load_dialog`
1593+
:meth:`NodeGraph.viewer().load_dialog`
15661594
15671595
Args:
15681596
current_dir (str): path to a directory.
@@ -1579,7 +1607,7 @@ def save_dialog(self, current_dir=None, ext=None):
15791607
15801608
Note:
15811609
Convenience function to
1582-
:meth:`NodeGraphQt.NodeGraph.viewer().save_dialog`
1610+
:meth:`NodeGraph.viewer().save_dialog`
15831611
15841612
Args:
15851613
current_dir (str): path to a directory.

0 commit comments

Comments
 (0)