Merge pull request #26 from timholy/teh/argorder

Change the argument order to `definition(String, ::Method)`

Author: timholy

README.md

@@ -49,8 +49,8 @@ julia> definition(m)
           c.r
       end)
 
-julia> definition(m, String)
-"red(c::AbstractRGB   ) = c.r\n"
+julia> str, line1 = definition(String, m)
+("red(c::AbstractRGB   ) = c.r\n", 14)
 ```
 
 or to find the method-signatures at a particular location:

src/CodeTracking.jl

@@ -175,15 +175,16 @@ function signatures_at(id::PkgId, relpath::AbstractString, line::Integer)
 end
 
 """
-    src, line1 = definition(method::Method, String)
+    src, line1 = definition(String, method::Method)
 
 Return a string with the code that defines `method`. Also return the first line of the
-definition, including the signature.
+definition, including the signature (which may not be the same line number returned
+by `whereis`).
 
 Note this may not be terribly useful for methods that are defined inside `@eval` statements;
-see [`definition(method::Method, Expr)`](@ref) instead.
+see [`definition(Expr, method::Method)`](@ref) instead.
 """
-function definition(method::Method, ::Type{String})
+function definition(::Type{String}, method::Method)
     file, line = whereis(method)
     src = read(file, String)
     eol = isequal('\n')
@@ -209,12 +210,12 @@ function definition(method::Method, ::Type{String})
 end
 
 """
-    ex = definition(method::Method, Expr)
+    ex = definition(Expr, method::Method)
     ex = definition(method::Method)
 
 Return an expression that defines `method`.
 """
-function definition(method::Method, ::Type{Expr})
+function definition(::Type{Expr}, method::Method)
     def = get(method_info, method.sig, nothing)
     if def === nothing
         f = method_lookup_callback[]
@@ -229,7 +230,7 @@ function definition(method::Method, ::Type{Expr})
     return def === nothing || ismissing(def) ? nothing : copy(def[2])
 end
 
-definition(method::Method) = definition(method, Expr)
+definition(method::Method) = definition(Expr, method)
 
 """
     info = pkgfiles(name::AbstractString)

test/runtests.jl

@@ -20,7 +20,7 @@ isdefined(Main, :Revise) ? includet("script.jl") : include("script.jl")
     @test whereis(trace[2]) == (scriptpath, 11)
     @test whereis(trace[3]) === nothing
 
-    src, line = definition(m, String)
+    src, line = definition(String, m)
     @test src == """
     function f1(x, y)
         # A comment
@@ -30,7 +30,7 @@ isdefined(Main, :Revise) ? includet("script.jl") : include("script.jl")
     @test line == 2
 
     m = first(methods(f2))
-    src, line = definition(m, String)
+    src, line = definition(String, m)
     @test src == """
     f2(x, y) = x + y
     """