Răsfoiți Sursa

docs: Add script_description to scripting

Added missing documentation for script_description function.
skeletonbow 3 ani în urmă
părinte
comite
70460564d1
1 a modificat fișierele cu 4 adăugiri și 0 ștergeri
  1. 4 0
      docs/sphinx/scripting.rst

+ 4 - 0
docs/sphinx/scripting.rst

@@ -35,6 +35,10 @@ Script Function Exports
 There are a number of global functions that scripts can optionally
 provide:
 
+.. py:function:: script_description()
+   Called to retrieve a description string to be displayed to the user
+   in the Scripts window.
+
 .. py:function:: script_load(settings)
 
    Called on script startup with specific settings associated with the