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

Full API should be in online documentation #326

Closed
cmcaine opened this issue Jul 22, 2019 · 3 comments
Closed

Full API should be in online documentation #326

cmcaine opened this issue Jul 22, 2019 · 3 comments

Comments

@cmcaine
Copy link
Contributor

cmcaine commented Jul 22, 2019

The docstrings for e.g. ftest are not present in the generated
documentation but are quite useful. I think the full API should be in
the generated docs.

@nalimilan
Copy link
Member

Sure. Would you add them to the relevant files?

@cmcaine
Copy link
Contributor Author

cmcaine commented Jul 27, 2019

There's a bunch of stuff missing. How do you feel about @autodocs? https://juliadocs.github.io/Documenter.jl/stable/man/syntax/#@autodocs-block-1

@andreasnoack
Copy link
Member

The doc build currently shows

Warning: 8 docstrings not included in the manual:

    GLM.wrkresp! :: Union{Tuple{T}, Tuple{T, GLM.GlmResp{T}}} where T<:(AbstractVector{T} where T<:AbstractFloat)
    GLM.wrkresp :: Tuple{GLM.GlmResp}
    GLM.linpred :: Union{Tuple{GLM.LinPred}, Tuple{GLM.LinPred, Real}}
    GLM.linpred! :: Union{Tuple{Any, GLM.LinPred}, Tuple{Any, GLM.LinPred, Real}}
    GLM.updateμ!
    GLM.delbeta!
    StatsAPI.predict! :: Tuple{Union{NamedTuple{(:prediction, :lower, :upper), <:Tuple{AbstractVector, AbstractVector, AbstractVector}}, AbstractVector}, GLM.AbstractGLM, AbstractMatrix}
    GLM._safe_int :: Tuple{T} where T<:AbstractFloat

so while these have docstring but are missing in the API section, I think that is okay as these should probably not be considered public API. We could consider converting the docstrings to comments to avoid the warnings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants