From 646fa341abd93db838ed2babe1b49b01e21ea196 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 23 Aug 2023 14:22:55 -0400 Subject: [PATCH] Closes #13470: Remove misleading statement about access to report results --- docs/customization/reports.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/customization/reports.md b/docs/customization/reports.md index b68e17bf4..7e3681304 100644 --- a/docs/customization/reports.md +++ b/docs/customization/reports.md @@ -111,7 +111,7 @@ The following methods are available to log results within a report: The recording of one or more failure messages will automatically flag a report as failed. It is advised to log a success for each object that is evaluated so that the results will reflect how many objects are being reported on. (The inclusion of a log message is optional for successes.) Messages recorded with `log()` will appear in a report's results but are not associated with a particular object or status. Log messages also support using markdown syntax and will be rendered on the report result page. -To perform additional tasks, such as sending an email or calling a webhook, before or after a report is run, extend the `pre_run()` and/or `post_run()` methods, respectively. The status of a completed report is available as `self.failed` and the results object is `self.result`. +To perform additional tasks, such as sending an email or calling a webhook, before or after a report is run, extend the `pre_run()` and/or `post_run()` methods, respectively. 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.