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.

Sign up for GitHub

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

Jump to bottom

Falsely Reported Missing Docstrings #81

Closed
jeremylt opened this issue Apr 4, 2023 · 1 comment
Closed

Falsely Reported Missing Docstrings #81

jeremylt opened this issue Apr 4, 2023 · 1 comment
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@jeremylt
Copy link
Owner

jeremylt commented Apr 4, 2023 

┌ Warning: 6 docstrings not included in the manual:
│ 
│     LFAToolkit.computesymbols :: Tuple{Jacobi, Array{<:Real}, Array{<:Real}}
│     LFAToolkit.computesymbols :: Tuple{Chebyshev, Array{<:Real}, Array{<:Real}}
│     LFAToolkit.computesymbols :: Tuple{BDDC, Array{<:Real}, Array{<:Real}}
│     LFAToolkit.computesymbols :: Tuple{Multigrid, Array{<:Real}, Array{Int64}, Array{<:Real}}
│     LFAToolkit.computesymbols :: Tuple{Operator, Array{<:Real}}
│     LFAToolkit.computesymbolsoverrange :: Tuple{Multigrid, Array{<:Real}, Array{Int64}, Int64}
│ 
│ These are docstrings in the checked modules (configured with the modules keyword)
│ that are not included in @docs or @autodocs blocks.

There is some trick to fixing this false report, but I don't recall it at the moment
@jeremylt jeremylt added bug Something isn't working documentation Improvements or additions to documentation labels Apr 4, 2023
@jeremylt
Copy link
Owner Author

jeremylt commented Apr 4, 2023

Duplicate of #66

@jeremylt jeremylt marked this as a duplicate of #66 Apr 4, 2023
@jeremylt jeremylt closed this as completed Apr 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jeremylt