Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add an error hint for min/max on an iterable #52716

Merged
merged 4 commits into from
Jan 9, 2024
Merged

add an error hint for min/max on an iterable #52716

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
60fd75e
add an error hint for min/max on an array
Jan 3, 2024
dcceabe
tweak wording, add tests
Jan 4, 2024
e65e277
Merge branch 'master' into kc/min_max_array_errorhint
KristofferC Jan 4, 2024
864f887
register error hint in tests
Jan 8, 2024
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
12 changes: 12 additions & 0 deletions base/errorshow.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1023,6 +1023,18 @@ end

Experimental.register_error_hint(string_concatenation_hint_handler, MethodError)


# Display a hint in case the user tries to use the min or max function on an iterable
function min_max_on_iterable(io, ex, arg_types, kwargs)
@nospecialize
if (ex.f === max || ex.f === min) && length(arg_types) == 1 && Base.isiterable(only(arg_types))
f_correct = ex.f === max ? "maximum" : "minimum"
print(io, "\nFinding the $f_correct of an iterable is performed with `$f_correct`.")
end
end

Experimental.register_error_hint(min_max_on_iterable, MethodError)

# ExceptionStack implementation
size(s::ExceptionStack) = size(s.stack)
getindex(s::ExceptionStack, i::Int) = s.stack[i]
Expand Down
10 changes: 10 additions & 0 deletions test/errorshow.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ include("testenv.jl")
# re-register only the error hints that are being tested here (
Base.Experimental.register_error_hint(Base.noncallable_number_hint_handler, MethodError)
Base.Experimental.register_error_hint(Base.string_concatenation_hint_handler, MethodError)
Base.Experimental.register_error_hint(Base.min_max_on_iterable, MethodError)

@testset "SystemError" begin
err = try; systemerror("reason", Cint(0)); false; catch ex; ex; end::SystemError
Expand Down Expand Up @@ -998,6 +999,15 @@ let err_str
@test occursin("String concatenation is performed with *", err_str)
end

let err_str
err_str = @except_str min([1,2,3]) MethodError
@test occursin("Finding the minimum of an iterable is performed with `minimum`.", err_str)
err_str = @except_str min((i for i in 1:3)) MethodError
@test occursin("Finding the minimum of an iterable is performed with `minimum`.", err_str)
err_str = @except_str max([1,2,3]) MethodError
@test occursin("Finding the maximum of an iterable is performed with `maximum`.", err_str)
end

@testset "unused argument names" begin
g(::Int) = backtrace()
bt = g(1)
Expand Down