Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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])
```
12 changes: 12 additions & 0 deletions src/ModelAnalyzer.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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(
Expand Down Expand Up @@ -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
Expand Down
8 changes: 7 additions & 1 deletion test/numerical.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading