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

Clarify missing docstrings warning/error #1405

Merged
merged 1 commit into from
Aug 17, 2020
Merged

Clarify missing docstrings warning/error #1405

merged 1 commit into from
Aug 17, 2020

Conversation

mortenpi
Copy link
Member

I think the "N docstrings potentially missing" message has caused quite a bit of confusion over the years. This phrasing should be more clear:

┌ Warning: 2 docstrings not included in the manual:
│        
│     Documenter.hide :: Tuple{Pair,Any}        
│     Documenter.hide :: Tuple{Pair}
│                     
│ These are docstrings in the checked modules (configured with the modules keyword)
│ that are not included in @docs or @autodocs blocks.            
└ @ Documenter.DocChecks ~/Julia/JuliaDocs/Documenter/src/DocChecks.jl:69

@mortenpi mortenpi added this to the 0.25.2 milestone Aug 17, 2020
@mortenpi mortenpi merged commit 70d1aba into master Aug 17, 2020
@mortenpi mortenpi deleted the mp/missing-error branch August 17, 2020 09:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants