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

Wrong paths for docstrings #22105

Closed
mortenpi opened this issue May 28, 2017 · 6 comments · Fixed by #22113
Closed

Wrong paths for docstrings #22105

mortenpi opened this issue May 28, 2017 · 6 comments · Fixed by #22113
Labels
docsystem The documentation building system

Comments

@mortenpi
Copy link
Contributor

It seems that the :path data items for docstrings (DocStr) do not get populated properly anymore. Documenter uses it to filter methods by file.

julia> using Documenter
julia> x = (Docs.meta(Documenter) |> first).second.docs;
julia> first(x).second.data
Dict{Symbol,Any} with 5 entries:
  :typesig    => Tuple{}
  :module     => Documenter
  :linenumber => 57
  :binding    => Documenter.deploydocs
  :path       => "docs/Docs.jl"

On 0.6.0-rc2:

julia> first(x).second.data
Dict{Symbol,Any} with 5 entries:
  :typesig    => Tuple{}
  :module     => Documenter
  :linenumber => 57
  :binding    => Documenter.makedocs
  :path       => "/home/morten/Julia/pkg/v0.6/Documenter/src/Documenter.jl"

Interestingly, the docstrings for base seem fine on master:

julia> x = (Docs.meta(LinAlg) |> first).second.docs;
julia> first(x).second.data
Dict{Symbol,Any} with 5 entries:
  :typesig    =>  
  :module     => Base.LinAlg
  :linenumber => 527
  :binding    => Base.LinAlg.lowrankupdate!
  :path       => "linalg/cholesky.jl"
@tkelman
Copy link
Contributor

tkelman commented May 28, 2017

would help to bisect when it went wrong

@mortenpi
Copy link
Contributor Author

It appears it was introduced in #21746. @vtjnash? I guess the problem could be base/docs/Docs.jl#L499?

@tkelman
Copy link
Contributor

tkelman commented May 28, 2017

#21746 isn't on release-0.6 though...

@mortenpi
Copy link
Contributor Author

Nope, the issue is with master/0.7. No worries if there isn't time to look into this now, it's a relatively obscure feature of Documenter that doesn't work properly on the nightlies. I just wanted to write up what I found since I was trying to figure out why the nightly tests fail on Documenter.

@tkelman
Copy link
Contributor

tkelman commented May 28, 2017

Oh, I misread

the docstrings for base seem fine on master:

then.

vtjnash added a commit that referenced this issue May 29, 2017
vtjnash added a commit that referenced this issue May 29, 2017
@vtjnash
Copy link
Member

vtjnash commented May 29, 2017

Thanks for the catch. I didn't realize I had the fix for this was trapped on #22064.

vtjnash added a commit that referenced this issue May 29, 2017
@kshyatt kshyatt added the docsystem The documentation building system label May 29, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docsystem The documentation building system
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants