DocStringExtensions.jl

DocStringExtensions.jl copied to clipboard

I am often finding myself in the situation where I dewsign an interface, and the algorithm-deciding arugments of the interface are all subtypes of a main abstract type. Like ```...

Datseris

FUNCTIONNAME inside a function that generates the docstring

7

Is it possible to get FUNCTIONNAME to work inside a function that generates the docstring? Something similar to ``` function gen_docstring() """ $(FUNCTIONNAME)(x) """ end @doc gen_docstring() function f(x) x...

ArnoStrouwen

Would it be possible to add a TYPEDMETHODLIST abbreviation

2

Currently I have a module set up like this ```jl module abcFunctionsModule using DocStringExtensions DocStringExtensions.@template TYPES = """ $(TYPEDEF) # Descriptions $(DOCSTRING) """ DocStringExtensions.@template (FUNCTIONS) = """ $(METHODLIST) # Description...

unnamedunknownusername

Internal errors when (ab)using `@template`

1

I was trying to better understand what the `@template` macro does, and ran into some internal errors when I was trying out some (admittedly, perhaps silly) cases. I don't think...

mortenpi

SIGNATURES in composite type definition

1

I wonder if it would it make sense to allow ```julia """ $(SIGNATURES) """ Base.@kwdef struct Foo a b end ``` document the constructors of `Foo`. This would be especially...

tpapp

Include the defaults for keyword arguments

6

For example, `DocStringExtensions` produces the signature ``` julia iterate(ivp; solver, opts...) ``` for the following function definition ``` function iterate{S

pwl

SUBTYPES abbreviation

3

It may be useful to add a `SUBTYPES` abbreviation that expands to something like ```julia subtypes: [`SubType1`](@ref), [`SubType2`](@ref), ... ```

tpapp

destructuring in SIGNATURES show #temp

2

```julia julia> using DocStringExtensions julia> """ $(SIGNATURES) This function destructures! """ function f((x, y)) x + y end f julia> @doc f f(#temp#) This function destructures! julia> VERSION v"1.0.1-pre.0" ```...

tpapp

Default argument value in function documentation

11

Consider the following documentation for a function `f1` in a module `CGP` ```julia """ $(TYPEDSIGNATURES) """ function f1(a::Int, b::Int=0) return a + b end ``` The generated documentation is ...

ShuhuaGao

Display parametric types in a better way?

2

Consider the following two functions in module `CGP`. ```julia """ $(TYPEDSIGNATURES) """ function fun1(x::AbstractVector{

ShuhuaGao