Skip to content

Commit 3acdb72

Browse files
committed
Write docstring instead of comment for initialization function
1 parent e583e68 commit 3acdb72

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

NodeToPython/compositor/operator.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ def _create_scene(self, indent_level: int):
5858

5959
def _initialize_compositor_node_tree(self, ntp_nt, nt_name):
6060
#initialize node group
61-
self._write(f"#initialize {nt_name} node group", self._outer_indent_level)
6261
self._write(f"def {ntp_nt.var}_node_group():", self._outer_indent_level)
62+
self._write(f'"""Initialize {nt_name} node group"""')
6363

6464
if ntp_nt.node_tree == self._base_node_tree and self.is_scene:
6565
self._write(f"{ntp_nt.var} = {SCENE}.node_tree")

NodeToPython/geometry/operator.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,8 @@ def _process_node_tree(self, node_tree: GeometryNodeTree) -> None:
116116
self._node_tree_vars[node_tree] = nt_var
117117

118118
#initialize node group
119-
self._write(f"#initialize {nt_var} node group", self._outer_indent_level)
120119
self._write(f"def {nt_var}_node_group():", self._outer_indent_level)
120+
self._write(f'"""Initialize {nt_var} node group"""')
121121
self._write(f"{nt_var} = bpy.data.node_groups.new("
122122
f"type = \'GeometryNodeTree\', "
123123
f"name = {str_to_py_str(node_tree.name)})\n")

NodeToPython/shader/operator.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ def _initialize_shader_node_tree(self, ntp_node_tree: NTP_NodeTree,
4242
variable to use
4343
nt_name (str): name to use for the node tree
4444
"""
45-
self._write(f"#initialize {nt_name} node group", self._outer_indent_level)
46-
self._write(f"def {ntp_node_tree.var}_node_group():\n", self._outer_indent_level)
45+
self._write(f"def {ntp_node_tree.var}_node_group():", self._outer_indent_level)
46+
self._write(f'"""Initialize {nt_name} node group"""')
4747

4848
if ntp_node_tree.node_tree == self._base_node_tree:
4949
self._write(f"{ntp_node_tree.var} = {MAT_VAR}.node_tree")

0 commit comments

Comments
 (0)