Skip to content

Commit

Permalink
Clarify missing docstrings warning/error (#1405)
Browse files Browse the repository at this point in the history
  • Loading branch information
mortenpi authored Aug 17, 2020
1 parent 6793bb3 commit 70d1aba
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion src/DocChecks.jl
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,15 @@ function missingdocs(doc::Documents.Document)
n = reduce(+, map(length, values(bindings)), init=0)
if n > 0
b = IOBuffer()
println(b, "$n docstring$(n 1 ? "" : "s") potentially missing:\n")
println(b, "$n docstring$(n 1 ? "" : "s") not included in the manual:\n")
for (binding, signatures) in bindings
for sig in signatures
println(b, " $binding", sig Union{} ? "" : " :: $sig")
end
end
println(b, """\n
These are docstrings in the checked modules (configured with the modules keyword)
that are not included in @docs or @autodocs blocks.""")
push!(doc.internal.errors, :missing_docs)
@logmsg loglevel(doc) String(take!(b))
end
Expand Down

0 comments on commit 70d1aba

Please sign in to comment.