Skip to content

Wrong paths for docstrings #22105

@mortenpi

Description

@mortenpi

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"

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsystemThe documentation building system

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions