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

Docstring check confused with reexported function #1695

Closed
nalimilan opened this issue Sep 11, 2021 · 0 comments · Fixed by #1861
Closed

Docstring check confused with reexported function #1695

nalimilan opened this issue Sep 11, 2021 · 0 comments · Fixed by #1861

Comments

@nalimilan
Copy link
Contributor

At https://github.com/JuliaData/CategoricalArrays.jl/pull/367/checks?check_run_id=3575057492 I see this error:

[ Info: CheckDocument: running document checks.
┌ Error: 1 docstring not included in the manual:
│ 
│     Missings.levels :: Tuple{CategoricalArray}
│ 
│ 
│ These are docstrings in the checked modules (configured with the modules keyword)
│ that are not included in @docs or @autodocs blocks.
└ @ Documenter.DocChecks ~/.julia/packages/Documenter/ruzxx/src/DocChecks.jl:69
[ Info: Populate: populating indices.
ERROR: LoadError: `makedocs` encountered an error. Terminating build

Yet the docstring is included in the manual, but it's DataAPI.levels (where the function is originally defined) rather than Missings.levels.

I could fix it by changing the definition of levels in Missings (see JuliaData/Missings.jl#138) from

export levels
import DataAPI
const levels = DataAPI.levels

to:

export levels
using DataAPI: levels

That's not a big deal but I figured I would report it in case the fix would be easy.

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

Successfully merging a pull request may close this issue.

2 participants