Kaynağa Gözat

chore: introduce the script_order notion in the documentation

maximumG 5 yıl önce
ebeveyn
işleme
7337630704
1 değiştirilmiş dosya ile 14 ekleme ve 0 silme
  1. 14 0
      docs/customization/custom-scripts.md

+ 14 - 0
docs/customization/custom-scripts.md

@@ -45,6 +45,20 @@ Defining script variables is optional: You may create a script with only a `run(
 
 
 Any output generated by the script during its execution will be displayed under the "output" tab in the UI.
 Any output generated by the script during its execution will be displayed under the "output" tab in the UI.
 
 
+By default, scripts within a module are ordered alphabetically in the scripts list page. To return scripts in a specific order, you can define the `script_order` variable at the end of your module. The `script_order` variable is a tuple which contains each Script class in the desired order. Any scripts that are omitted from this list will be listed last.
+
+```python
+from extras.scripts import Script
+
+class MyCustomScript(Script):
+    ...
+
+class AnotherCustomScript(Script):
+    ...
+
+script_order = (MyCustomScript, AnotherCustomScript)
+```
+
 ## Module Attributes
 ## Module Attributes
 
 
 ### `name`
 ### `name`