DocStringExtensions.jl

DocStringExtensions.jl copied to clipboard

Examples of how to use all of the functionality

5

This seems like a great package! One thing that's really missing is an example of how to use each and every functionality. Ideally, this would be a single page with...

andyDoucette

Update for Documenter v1

1

* Update Documenter.jl compat * Fix doctests

hyrodium

Bumps [actions/cache](https://github.com/actions/cache) from 3 to 4. Release notes Sourced from actions/cache's releases. v4.0.0 What's Changed Update action to node20 by @​takost in actions/cache#1284 feat: save-always flag by @​to-s in actions/cache#1242...

dependabot[bot]

what is the recommended way to document arguments used only for their type for SIGNATURES?

3

This is not (yet) a feature request, just asking for advice on using this package. Sometimes the *value* of an argument is not directly relevant, as the body uses their...

tpapp

Feature request: option to override template in specific case

4

Is it possible to override a set template for a particular docstring? In particular, my template involves `$TYPEDSIGNATURES`, and in a couple of exceptional cases, I would rather omit those...

tomerarnon

I would like a docstring for my many-method functions to look like: ```md f(x::Int, y::Float) Does something with `x` and `y`. defined at [blah.jl:100](link) - - - f(x::String) Does something...

tomerarnon

Feature request: TYPEDSIGNATURES without output type

1

As mentioned in the original typedsignatures issue: https://github.com/JuliaDocs/DocStringExtensions.jl/issues/20#issuecomment-461420993 generic julia code often doesn't have a definite return type. Would it be possible to either customize `TYPEDSIGNATURES` to omit this (or...

tomerarnon

TYPEDSIGNATURES error with @generated functions

3

This happens whether the function is `@generated`, or defined with `if @generated ...` method. ```julia_repl julia> using DocStringExtensions julia> begin """ $TYPEDSIGNATURES example """ @generated function example(x) :(return x) end...

tomerarnon

Feature/add typed method list abbreviation

2

WIP for #150 Essentially just copying the code from `MethodList` and creating `TypedMethodList` Then inserting a copy of a section of typed signatures into the right spot @MichaelHatherly, let me...

unnamedunknownusername

FIELDS / TYPEDFIELDS fail on const fields of mutable struct

3

Since v"1.8.0" its possible to annotate a mutable struct's field with the `const` keyword. If you do, DocStringExtensions `FIELDS`, `TYPEDFIELDS` fail: docstrings are only parsed for mutable fields. Here is...

i9e1