griefith/test
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Cleanup: replace doc-strings with comments for internal logic

Browse Source 
There is no need to store text in memory for comments on functions
that aren't exposed publicly and are only of used when reading
the code.
This commit is contained in:
Campbell Barton
2024-11-03 16:42:13 +11:00
parent ca8d00d0bb
commit 901359abf7
5 changed files with 118 additions and 131 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/python_api/examples/bpy.types.FileHandler.2.py
View File

@@ -72,14 +72,12 @@ class ShaderScriptImport(bpy.types.Operator, ImportHelper):
y -= 20.0
return {'FINISHED'}
"""
Use ImportHelper's invoke_popup() to handle the invocation so that this operator's properties
are shown in a popup. This allows the user to configure additional settings on the operator like
the `set_label` property. Consider having a draw() method on the operator in order to layout the
properties in the UI appropriately.
If filepath information is not provided the file select window will be invoked instead.
"""
# Use ImportHelper's invoke_popup() to handle the invocation so that this operator's properties
# are shown in a popup. This allows the user to configure additional settings on the operator like
# the `set_label` property. Consider having a draw() method on the operator in order to layout the
# properties in the UI appropriately.
#
# If filepath information is not provided the file select window will be invoked instead.
def invoke(self, context, event):
return self.invoke_popup(context)