DocStringExtensions.jl
DocStringExtensions.jl copied to clipboard
JuliaDocs
Extensions for Julia's docsystem.
Sometimes, short functions are best documented by their full definition (and sometimes I'm just lazy). It would be nice if `$(BODY)` was replaced with `log(p / (1 - p))`. ```julia...
as far as I can tell, there is only one abbreviation `TYPES` for types templates. I think it might be useful to have separate templates for abstract and concrete types,...
The idea is to have a macro, let us say, INTERNAL, such that a message warning the user that the function is internal is shown instead of the actual help...
There are a few doctest failures, probably due to printing changes between Julia versions. Also, doctest failures do not currently fail the documentation build. ``` ┌ Error: doctest failure in...
maybe I'm using it wrong, but ```julia module Foo @template MODULES = Foo end ``` resultes in ```julia ERROR: LoadError: KeyError: key :MODULES not found ```
The manual says: > This package provides a collection of useful extensions for Julia's built-in docsystem. These are features that are still regarded as "experimental" and not yet mature enough...
The v0.1 version of the documentation is the first result in a Google search for "docstringextensions" and the the third result for "docstringextensions.jl". This is very confusing because that page...
I find it very helpful to include `$(TYPEDSIGNATURES)` at the top of my function docstring template. I'm wondering why type annotations are included in positional arguments but not keyword arguments?...
`$TYPEDSIGNATURES` causes error when calling `Base.return_type` when typesig is `UnionAll` with generic types. I think the easy hacky solution to this is to wrap the following in a try except....
Is it possible to create a new `Abbreviation` type in a separate package? After implementing a `format` method I only see the proper print out when I run the docstring...
