Open ThomasBreuer opened 2 years ago
Help mode lookup and Documenter signature lookup are unrelated.
I am sure it is either https://github.com/JuliaLang/julia/issues/20064, https://github.com/JuliaDocs/Documenter.jl/issues/839 or https://github.com/JuliaLang/julia/issues/29437 :)
@thofma Thanks.
Help mode lookup and Documenter signature lookup are unrelated.
Part of the discussion in JuliaDocs/Documenter.jl/issues/839 expresses this. However, then we have (at least) two bugs here, one in the help system and one in Documenter, since the unrelated docstring is fetched in both situations.
Currently I find the following docstring for
gen
in the Oscar dev documentation of the abelian closure of the rationals.This docstring comes from the file
src/Modules/UngradedModules.jl
. The line that causes its inclusion is(see
docs/src/NumberTheory/abelian_closure.md
). Apparently the intended docstring fromsrc/Rings/AbelianClosure.jl
belongs toThus it is clear how to fix the problem.
Apparently we do not get an error message when building the documentation because the abovementioned docstring is found, but why is it found? In a Julia session, I get the following.
Thus I get the wrong docstring also when the correct signature is entered. Why? (This docstring is the last one that is shown when one enters
?gen
, but this should not matter.)