Skip to content

Commit ff5bcd0

Browse files
authored
Add missing reference material on report-splitting (#652)
Adds docstring for `get_reports`, add more `@docs`.
1 parent 68dea56 commit ff5bcd0

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

docs/src/optanalysis.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,14 @@ JET.@test_opt
237237
JET.test_opt
238238
```
239239

240+
### [Splitting and filtering reports](@id optanalysis-splitting)
241+
242+
The output of `JET.@report_opt` can be split into individual failures for integration with tools like Cthulhu:
243+
```@docs
244+
JET.get_reports
245+
JET.reportkey
246+
```
247+
240248
### [Top-level Entry Points](@id optanalysis-toplevel-entry)
241249

242250
By default, JET doesn't offer top-level entry points for the optimization analysis, because it's usually used for only a

src/JET.jl

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -410,6 +410,12 @@ function get_result(result::JETCallResult)
410410
return result.result.result
411411
end
412412
end
413+
414+
"""
415+
rpts = JET.get_reports(result::JETCallResult)
416+
417+
Split `result` into a vector of reports, one per issue.
418+
"""
413419
function get_reports(result::JETCallResult)
414420
reports = get_reports(result.analyzer, result.result)
415421
return configured_reports(reports; result.jetconfigs...)

0 commit comments

Comments
 (0)