Browse Source

Change fields to field_order

Jeremy Stretch 6 years ago
parent
commit
99394de14e
2 changed files with 6 additions and 6 deletions
  1. 3 3
      docs/additional-features/custom-scripts.md
  2. 3 3
      netbox/extras/scripts.py

+ 3 - 3
docs/additional-features/custom-scripts.md

@@ -55,12 +55,12 @@ This is the human-friendly names of your script. If omitted, the class name will
 
 
 A human-friendly description of what your script does.
 A human-friendly description of what your script does.
 
 
-### `fields`
+### `field_order`
 
 
-The order in which the variable fields should appear. This is optional, however on Python 3.5 and earlier the fields will appear in random order. (Declarative ordering is preserved on Python 3.6 and above.) For example:
+A list of field names indicating the order in which the form fields should appear. This is optional, however on Python 3.5 and earlier the fields will appear in random order. (Declarative ordering is preserved on Python 3.6 and above.) For example:
 
 
 ```
 ```
-fields = ['var1', 'var2', 'var3']
+field_order = ['var1', 'var2', 'var3']
 ```
 ```
 
 
 ## Reading Data from Files
 ## Reading Data from Files

+ 3 - 3
netbox/extras/scripts.py

@@ -178,9 +178,9 @@ class Script:
     def _get_vars(self):
     def _get_vars(self):
         vars = OrderedDict()
         vars = OrderedDict()
 
 
-        # Infer order from Meta.fields (Python 3.5 and lower)
-        fields = getattr(self.Meta, 'fields', [])
-        for name in fields:
+        # Infer order from Meta.field_order (Python 3.5 and lower)
+        field_order = getattr(self.Meta, 'field_order', [])
+        for name in field_order:
             vars[name] = getattr(self, name)
             vars[name] = getattr(self, name)
 
 
         # Default to order of declaration on class
         # Default to order of declaration on class