There’s a new minor release of DocStringExtensions.jl available.
For those unaware of it’s purpose it allows for automatically generating some parts of your docstrings, such as method signatures, struct field docs, etc. without having to manually keeping them in sync with changing code.
"""
$SIGNATURES
Your docs go here...
"""
f(x) = x + 1
Where $SIGNATURES becomes f(x) in this example. There’s a fair bit more than that possible, which is covered in the docs for those interested.
This new minor release shouldn’t be particularly breaking for most users, and some effort has gone into checking there were no regressions or breakage for packages that depend on it, though there may of course be some problems I’ve missed, in which case please do open an issue. The changelog lists the known cases where breakage might be experienced: mostly related to errors with @template usage being more upfront, hence failing to precompile a package that uses them wrong, rather than silently giving incorrect results.
The main aim with this release was to clear the issue backlog and make it generally more robust and correct. A bunch of features that have been asked for for years are now available, such as printing method argument default values, several new abbreviations (INSTANCES, SUBTYPES, BODY, and others), FIELDS printing default values for @kwdef structs, and general improvements of the outputs that DocStringExtensions renders for it’s various abbreviations.
Enjoy!