fix docing call overloads (JuliaLang#25626)

tekverkp · Jan 18, 2018 · 71173e4 · 71173e4
1 parent 11cbc4d
commit 71173e4
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/base/docs/Docs.jl b/base/docs/Docs.jl
@@ -462,6 +462,9 @@ namify(x) = nameof(x, isexpr(x, :macro))
 function nameof(x::Expr, ismacro)
  if isexpr(x, :.)
  ismacro ? macroname(x) : x
+ # Call overloading, e.g. `(a::A)(b) = b` or `function (a::A)(b) b end` should document `A(b)`
+ elseif (isexpr(x, :function) || isexpr(x, :(=))) && isexpr(x.args[1], :call) && isexpr(x.args[1].args[1], :(::))
+ return nameof(x.args[1].args[1].args[2], ismacro)
  else
  n = isexpr(x, (:module, :struct)) ? 2 : 1
  nameof(x.args[n], ismacro)

diff --git a/test/docs.jl b/test/docs.jl
@@ -1092,3 +1092,30 @@ end
 struct t_docs_abc end
 @test "t_docs_abc" in Docs.accessible(@__MODULE__)
 
+# Call overloading issue #20087
+"""
+Docs for `MyFunc` struct.
+"""
+mutable struct MyFunc
+ x
+end
+
+"""
+Docs for calling `f::MyFunc`.
+"""
+function (f::MyFunc)(x)
+ f.x = x
+ return f
+end
+
+@test docstrings_equal(@doc(MyFunc(2)),
+doc"""
+Docs for calling `f::MyFunc`.
+""")
+
+struct A_20087 end
+
+"""a"""
+(a::A_20087)() = a
+
+@test docstrings_equal(@doc(A_20087()), doc"a")