Преглед изворни кода

Changelog & docs cleanup for #6973

jeremystretch пре 4 година
родитељ
комит
fd180e480a
2 измењених фајлова са 3 додато и 3 уклоњено
  1. 1 2
      docs/customization/reports.md
  2. 2 1
      docs/release-notes/version-3.0.md

+ 1 - 2
docs/customization/reports.md

@@ -97,8 +97,7 @@ The recording of one or more failure messages will automatically flag a report a
 
 To perform additional tasks, such as sending an email or calling a webhook, after a report has been run, extend the `post_run()` method. The status of the report is available as `self.failed` and the results object is `self.result`.
 
-By default, reports within a module are unordered and 'randomly' displayed in the reports list page. If you want to order reports, you can defined the `report_order` variable at the end
-of your module. The `report_order` variable is a tuple which contains each Report class in a specific order.
+By default, reports within a module are ordered alphabetically in the reports list page. To return reports in a specific order, you can define the `report_order` variable at the end of your module. The `report_order` variable is a tuple which contains each Report class in the desired order. Any reports that are omitted from this list will be listed last.
 
 ```
 from extras.reports import Report

+ 2 - 1
docs/release-notes/version-3.0.md

@@ -4,7 +4,8 @@
 
 ### Enhancements
 
-* [#6917](https://github.com/netbox-community/netbox/issues/6917) - Make ip assigned checkmark in ip table link to interface
+* [#6917](https://github.com/netbox-community/netbox/issues/6917) - Make IP assigned checkmark in IP table link to interface
+* [#6973](https://github.com/netbox-community/netbox/issues/6973) - Enable custom ordering of reports
 * [#7118](https://github.com/netbox-community/netbox/issues/7118) - Render URL custom fields as hyperlinks in object tables
 * [#7323](https://github.com/netbox-community/netbox/issues/7323) - Add serial filter field for racks & devices
 * [#7372](https://github.com/netbox-community/netbox/issues/7372) - Link to local docs for model from object add/edit views