A Julia docstring linter to check for various quality indications, taking into account the method(s) a docstring applies to.
Basic usage
julia> using CheckDoc
julia> checkdocs(MyPackage)Target docstring format
This built-in rules encourage adherence to the Julia manual’s suggested style, along with some extra rules to help aid clarity and consistency.
SIGNATURE
Concise summary, as a complete sentence in an imperitive style.
Elaboration, mentioning all arguments and keyword arguments in order (when a function).
