estel/netbox
1
0
Fork 0
Code Issues Pull Requests Actions 4 Packages Projects Releases Wiki Activity

16050 Show script python_class name and description (#16185)

Browse Source 
* 16050 Show script python_class name and description

* 16050 change to use Meta.description

* 16050 change to use Meta.description

* 16050 remove module name customization from docs
This commit is contained in:
Arthur Hanson
2024-06-06 06:05:59 -07:00
committed by GitHub
parent 18b43408ec
commit 8f87c72eaa
3 changed files with 5 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/customization/custom-scripts.md
View File

@@ -65,12 +65,6 @@ class AnotherCustomScript(Script):
script_order = (MyCustomScript, AnotherCustomScript)
```
## Module Attributes
### `name`
You can define `name` within a script module (the Python file which contains one or more scripts) to set the module name. If `name` is not defined, the module's file name will be used.
## Script Attributes
Script attributes are defined under a class named `Meta` within the script. These are optional, but encouraged.