Extensions for Julia's docsystem.
| Documentation | Build Status |
|---|---|
  |
  |
DocStringExtensions generates parts of a docstring from the code it documents. Interpolate an abbreviation into a docstring, and it expands to Markdown when the docstring is shown:
using DocStringExtensions
"""
$(TYPEDSIGNATURES)
Compute the area of a circle with radius `r`.
"""
area(r::Float64) = π * r^2?area in the REPL then shows the signature area(r::Float64) -> Float64 above the summary.
pkg> add DocStringExtensions
CI tests these Julia versions:
- Linux: 1.0, 1.6, the LTS, the latest release, and nightly.
- macOS and Windows: the latest release.
Open an issue for bugs and feature requests. Ask questions on the Julia Discourse.