You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When you have missing docstrings, you get an error like this:
┌ Warning: 9 docstrings not included in the manual:
│
│ ExponentialUtilities.phiv_dense :: Tuple{Any, Any, Any}
│ LinearAlgebra.LAPACK.stegr! :: Union{Tuple{T}, Tuple{AbstractVector{T}, AbstractVector{T}, ExponentialUtilities.Stegr.StegrWork{T}}} where T
│ ExponentialUtilities.kiops :: Tuple{Any, Any, Any}
│ ExponentialUtilities.phiv_dense! :: Union{Tuple{T}, Tuple{AbstractMatrix{T}, AbstractMatrix{T}, AbstractVector{T}, Integer}} where T<:Number
│ ExponentialUtilities.phi! :: Union{Tuple{T}, Tuple{Array{Matrix{T}, 1}, AbstractMatrix{T}, Integer}} where T<:Number
│ ExponentialUtilities.realview :: Union{Tuple{C}, Tuple{R}, Tuple{Type{R}, AbstractVector{C}}} where {R, C<:Complex}
│ ExponentialUtilities.Stegr.StegrWork :: Union{Tuple{T}, Tuple{Type{T}, Integer}, Tuple{Type{T}, Integer, Char}, Tuple{Type{T}, Integer, Char, Char}} where T
│ ExponentialUtilities.expT! :: Union{Tuple{R}, Tuple{T}, Tuple{AbstractVector{R}, AbstractVector{R}, Number, StegrCache{T, R}}} where {T, R<:Real}
│ ExponentialUtilities.@diagview :: Union{Tuple{Any}, Tuple{Any, Integer}}
│
│ These are docstrings in the checked modules (configured with the modules keyword)
│ that are not included in canonical @docs or @autodocs blocks.
└ @ Documenter ~/.julia/packages/Documenter/nGNwI/src/utilities/utilities.jl:46
It would be good to point the user to the file and line range where the docstring occurs, so that they'd be able to check out what docstring is giving them the error. In particular, this would be useful for docstrings for overloaded functions such as LinearAlgebra.LAPACK.stegr! above.
The text was updated successfully, but these errors were encountered:
When you have missing docstrings, you get an error like this:
It would be good to point the user to the file and line range where the docstring occurs, so that they'd be able to check out what docstring is giving them the error. In particular, this would be useful for docstrings for overloaded functions such as
LinearAlgebra.LAPACK.stegr!
above.The text was updated successfully, but these errors were encountered: