-
Notifications
You must be signed in to change notification settings - Fork 482
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
Alias docstring not found #2087
Comments
|
I could put that, but I'm listing it in the documentation as an exported symbol of It is an alias, but might it be possible for |
An update on this, trying In the build logs, I just see:
In the meantime, having a quick look at juila> using .Docs
julia> using Documenter
julia> bind = Docs.Binding(DataToolkit, Symbol("@addpkg"))
DataToolkit.@addpkg
julia> bind == Documenter.DocSystem.binding(DataToolkit, Symbol("@addpkg"))
true
julia> Documenter.DocSystem.getdocs(bind, Union{Tuple{}}; modules = [DataToolkit])
Base.Docs.DocStr[]
julia> Docs.doc(bind, Union{Tuple{}})
@addpkg name::Symbol uuid::String
Register the package identifed by name with UUID uuid. This package may now be used with @import $name.
All @addpkg statements should lie within a module's __init__ function.
Example
≡≡≡≡≡≡≡≡≡
@addpkg CSV "336ed68f-0bac-5ca0-87d4-7b16caf5d00b" I'd be curious to know why Documenter doesn't use |
I think we'd need Michael from 8 years ago to answer this question 😆 Not at all sure, but possibly because Documenter predates That said, I am also not immediately sure that |
I just thought I'd comment that I'm still trying (and failing) to get this to work. |
What if you pass Line 22 in 7d3dc2c
It would still show |
I have a package that re-exports some symbols from another packages of mine.
In the Documenter.jl-generated docs, I see "Missing docstring for DataToolkit.@addpkg. Check Documenter's build log for details.", but in the Julia REPL the docstring appears without issue.
So, it would appear that Documenter.jl has a problem with aliases.
The text was updated successfully, but these errors were encountered: