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.

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

a problem with the Julia help system #1314

Open
ThomasBreuer opened this issue May 9, 2022 · 2 comments
Open

a problem with the Julia help system #1314

ThomasBreuer opened this issue May 9, 2022 · 2 comments
Labels
bug Something isn't working

Comments

@ThomasBreuer
Copy link
Member

Currently I find the following docstring for gen in the Oscar dev documentation of the abelian closure of the rationals.

gen(M::SubQuo{T}, i::Int) where T

Return the ith generator of M.

This docstring comes from the file src/Modules/UngradedModules.jl. The line that causes its inclusion is

gen(::QabField)

(see docs/src/NumberTheory/abelian_closure.md).
Apparently the intended docstring from src/Rings/AbelianClosure.jl belongs to

gen(K::QabField{AnticNumberField})

Thus 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.

julia> using Oscar
[...]

help?> gen(::QabField)
  gen(M::SubQuo{T}, i::Int) where T

  Return the ith generator of M.

help?> gen(::QabField{AnticNumberField})
  gen(K::QabField)

  Return the generator of the abelian closure K that can be used to construct
  primitive roots of unity.

  ────────────────────────────────────────────────────────────────────────────

  gen(M::SubQuo{T}, i::Int) where T

  Return the ith generator of M.

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.)

@ThomasBreuer ThomasBreuer added the bug Something isn't working label May 9, 2022
@thofma
Copy link
Collaborator

thofma commented May 9, 2022

Help mode lookup and Documenter signature lookup are unrelated.

I am sure it is either JuliaLang/julia#20064, JuliaDocs/Documenter.jl#839 or JuliaLang/julia#29437 :)

@ThomasBreuer
Copy link
Member Author

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants