Skip to content

Commit 7b0c0a2

Browse files
committed
name_source -> model
1 parent cea96e6 commit 7b0c0a2

File tree

2 files changed

+96
-149
lines changed

2 files changed

+96
-149
lines changed

src/ModelAnalyzer.jl

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ See [`summarize`](@ref), [`list_of_issues`](@ref), and
2727
function analyze end
2828

2929
"""
30-
summarize([io::IO,] AbstractData; name_source = nothing, verbose = true, max_issues = typemax(Int), kwargs...)
30+
summarize([io::IO,] AbstractData; model = nothing, verbose = true, max_issues = typemax(Int), kwargs...)
3131
3232
Print a summary of the analysis results contained in `AbstractData` to the
3333
specified IO stream. If no IO stream is provided, it defaults to `stdout`.
@@ -43,11 +43,11 @@ be a subtype of `AbstractIssue`). In the verbose case it will provide a text
4343
explaning the issue. In the non-verbose case it will provide just the issue
4444
name.
4545
46-
summarize([io::IO,] issue::AbstractIssue; name_source = nothing, verbose = true)
46+
summarize([io::IO,] issue::AbstractIssue; model = nothing, verbose = true)
4747
4848
This variant allows summarizing a single issue instance of type `AbstractIssue`.
49-
The model tha led to the issue can be provided to `name_source`, it will be used
50-
to generate the name of variables and constraints in the issue summary.
49+
The model that led to the issue can be provided to `model`, it will be
50+
used to generate the name of variables and constraints in the issue summary.
5151
"""
5252
function summarize end
5353

@@ -79,20 +79,20 @@ end
7979
function summarize(
8080
io::IO,
8181
issue::AbstractIssue;
82-
name_source = nothing,
82+
model = nothing,
8383
verbose = true,
8484
)
8585
if verbose
86-
return _verbose_summarize(io, issue, name_source)
86+
return _verbose_summarize(io, issue, model)
8787
else
88-
return _summarize(io, issue, name_source)
88+
return _summarize(io, issue, model)
8989
end
9090
end
9191

9292
function summarize(
9393
io::IO,
9494
issues::Vector{T};
95-
name_source = nothing,
95+
model = nothing,
9696
verbose = true,
9797
max_issues = typemax(Int),
9898
) where {T<:AbstractIssue}
@@ -102,7 +102,7 @@ function summarize(
102102
print(io, "\n\n## List of issues\n\n")
103103
for issue in first(issues, max_issues)
104104
print(io, " * ")
105-
summarize(io, issue, verbose = verbose, name_source = name_source)
105+
summarize(io, issue, verbose = verbose, model = model)
106106
print(io, "\n")
107107
end
108108
return

0 commit comments

Comments
 (0)