-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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
Bad docstring path/linenumber if in macro call #36906
Comments
The """
struct A
"""
Base.@kwdef struct A
"""A well-documented integer."""
a::Int = 1
end
"""
struct B
"""
struct B
"""A well-documented integer."""
a::Int
end
Base.@kwdef struct C
"""A well-documented integer."""
a::Int = 1
end
@doc """
struct C
""" C we have
|
This was referenced Aug 9, 2020
MichaelHatherly
added a commit
to MichaelHatherly/julia
that referenced
this issue
Aug 19, 2020
Fixes JuliaLang#36906, where source info wasn't being passed through at-doc when it was applied to definitions defined within macros.
StefanKarpinski
pushed a commit
that referenced
this issue
Aug 19, 2020
Fixes #36906, where source info wasn't being passed through at-doc when it was applied to definitions defined within macros.
simeonschaub
pushed a commit
to simeonschaub/julia
that referenced
this issue
Aug 29, 2020
Fixes JuliaLang#36906, where source info wasn't being passed through at-doc when it was applied to definitions defined within macros.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The filename and line numbers for a docstring are not properly stored if the definition is wrapped in a macro call, e.g. in the following case:
For an MWE,
include
-ing this:will lead to this when fetching the docstring metadata (note the missing
:path
and:linenumber
forA
):X-ref: JuliaDocs/Documenter.jl#1374
The text was updated successfully, but these errors were encountered: