diff --git a/docs/src/index.md b/docs/src/index.md index e9631a1..b18086b 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -118,14 +118,14 @@ or it can be further inspected programmatically. list = ModelAnalyzer.list_of_issue_types(data) # information about the types of issues found can be printed out -ModelAnalyzer.summarize(data, list[1]) +ModelAnalyzer.summarize(list[1]) # for each issue type, you can get the actual issues found in the analysis issues = ModelAnalyzer.list_of_issues(data, list[1]) # the list of issues of the given type can be summarized with: -ModelAnalyzer.summarize(data, issues) +ModelAnalyzer.summarize(issues) # individual issues can also be summarized -ModelAnalyzer.summarize(data, issues[1]) +ModelAnalyzer.summarize(issues[1]) ``` diff --git a/src/ModelAnalyzer.jl b/src/ModelAnalyzer.jl index 04769cc..3c2697f 100644 --- a/src/ModelAnalyzer.jl +++ b/src/ModelAnalyzer.jl @@ -72,6 +72,10 @@ function summarize(io::IO, ::Type{T}; verbose = true) where {T<:AbstractIssue} end end +function summarize(::Type{T}; kwargs...) where {T<:AbstractIssue} + return summarize(stdout, T; kwargs...) +end + function summarize(io::IO, issue::AbstractIssue; verbose = true) if verbose return _verbose_summarize(io, issue) @@ -80,6 +84,10 @@ function summarize(io::IO, issue::AbstractIssue; verbose = true) end end +function summarize(issue::AbstractIssue; kwargs...) + return summarize(stdout, issue; kwargs...) +end + const DEFAULT_MAX_ISSUES = 10 function summarize( @@ -108,6 +116,10 @@ function summarize( return end +function summarize(issues::Vector{T}; kwargs...) where {T<:AbstractIssue} + return summarize(stdout, issues; kwargs...) +end + function summarize(data::AbstractData; kwargs...) return summarize(stdout, data; kwargs...) end diff --git a/test/numerical.jl b/test/numerical.jl index 40eaf0e..a3c7462 100644 --- a/test/numerical.jl +++ b/test/numerical.jl @@ -941,7 +941,13 @@ function test_many() ModelAnalyzer.summarize(buf, data, verbose = false) redirect_stdout(devnull) do - return ModelAnalyzer.summarize(data) + ModelAnalyzer.summarize(data) + list = ModelAnalyzer.list_of_issue_types(data) + ModelAnalyzer.summarize(list[1]) + issues = ModelAnalyzer.list_of_issues(data, list[1]) + ModelAnalyzer.summarize(issues) + ModelAnalyzer.summarize(issues[1]) + return end return