Merge branch 'main' into jg/moi

Author: joaquimg

docs/src/index.md

@@ -39,7 +39,7 @@ run:
 
 ```julia
 using Pkg
-Pkg.add("https://github.com/jump-dev/ModelAnalyzer.jl")
+Pkg.add(url = "https://github.com/jump-dev/ModelAnalyzer.jl")
 ```
 
 ## Usage
@@ -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])
 ```

src/ModelAnalyzer.jl

@@ -78,6 +78,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;
@@ -91,6 +95,10 @@ function summarize(
     end
 end
 
+function summarize(issue::AbstractIssue; kwargs...)
+    return summarize(stdout, issue; kwargs...)
+end
+
 const DEFAULT_MAX_ISSUES = 10
 
 function summarize(
@@ -120,6 +128,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

test/numerical.jl

@@ -942,7 +942,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