v0.10.0

DocStringExtensions v0.10.0

Diff since v0.9.5

See https://github.com/JuliaDocs/DocStringExtensions.jl/blob/master/CHANGELOG.md for a list of changes.

Merged pull requests:

• Update for Documenter v1 (#163) (@hyrodium)
• Bump actions/checkout from 4 to 5 (#177) (@dependabot[bot])
• Update CI (#178) (@fingolfin)
• Allow for omitting return types for typed method signatures (#179) (@ReubenJ)
• Switch to ReferenceTests.jl for testing output of format (#180) (@ReubenJ)
• Bump actions/checkout from 5 to 6 (#181) (@dependabot[bot])
• Bump julia-actions/cache from 2 to 3 (#183) (@dependabot[bot])
• Bump codecov/codecov-action from 5 to 6 (#184) (@dependabot[bot])
• Use invokelatest for resolution (#185) (@asinghvi17)
• Bump julia-actions/setup-julia from 2 to 3 (#186) (@dependabot[bot])
• Bump codecov/codecov-action from 6 to 7 (#188) (@dependabot[bot])
• Bump actions/checkout from 6 to 7 (#189) (@dependabot[bot])
• test: replace ReferenceTests and fix METHODLIST path redaction (#191) (@MichaelHatherly)
• test: check world-age formatting against references, add agent guides (#192) (@MichaelHatherly)
• fix(signatures): unnamed args, varargs and 1.12 typesig unions (#193) (@MichaelHatherly)
• feat(signatures): optionally show default argument values (#194) (@MichaelHatherly)
• docs: add a changelog backfilled from the release history (#196) (@MichaelHatherly)
• feat(methodlist): add TYPEDMETHODLIST abbreviation (#197) (@MichaelHatherly)
• fix(templates): reject template strings without DOCSTRING (#198) (@MichaelHatherly)
• fix(signatures): skip return types of generated methods on abstract types (#199) (@MichaelHatherly)
• feat(exports): add PUBLIC abbreviation (#200) (@MichaelHatherly)
• feat(enums): add INSTANCES abbreviation (#201) (@MichaelHatherly)
• fix(signatures): print destructured arguments as written (#204) (@MichaelHatherly)
• fix(templates): apply templates to docstrings with a define flag (#207) (@MichaelHatherly)
• ci: test on Julia 1.6 (#208) (@MichaelHatherly)
• fix(templates): apply a template once to macro-marked definitions (#209) (@MichaelHatherly)
• refactor(templates): resolve templates as each docstring is registered (#210) (@MichaelHatherly)
• fix(templates): explain a missing template when copying one (#212) (@MichaelHatherly)
• fix(signatures): drop the empty line before the closing fence (#214) (@MichaelHatherly)
• docs: split the manual into examples and reference pages (#215) (@MichaelHatherly)
• fix(format): name the type in two error messages (#216) (@MichaelHatherly)
• fix(methodlist): show source paths relative to the package root (#217) (@MichaelHatherly)
• fix(signatures): take the return type of the documented method (#218) (@MichaelHatherly)
• fix(signatures): skip inference when an overlapping method is generated (#222) (@MichaelHatherly)
• fix(templates): reject unknown template categories (#223) (@MichaelHatherly)
• fix(signatures): type signatures whose typesig loses arity (#225) (@MichaelHatherly)
• fix(templates): give parametric constructors the METHODS template (#226) (@MichaelHatherly)
• feat(types): add SUBTYPES abbreviation (#227) (@MichaelHatherly)
• fix(signatures): print varargs as xs::T... before Julia 1.5 (#228) (@MichaelHatherly)
• fix(signatures): print fixed-count varargs as Vararg{T, n} (#229) (@MichaelHatherly)
• fix(signatures): name type parameters in a where clause (#230) (@MichaelHatherly)
• fix(signatures): keep a parametric default-before-vararg group on 1.12 (#231) (@MichaelHatherly)
• fix(signatures): prefer the typesig tuple equal to the method's own (#232) (@MichaelHatherly)
• fix(signatures): describe constructors written as T{P}(...) (#234) (@MichaelHatherly)
• feat(signatures): print the type of a typed unnamed argument (#235) (@MichaelHatherly)
• fix: pass the test suite on Julia 1.14 nightly (#236) (@MichaelHatherly)
• feat(abbreviations): add BODY to print a method's body (#237) (@MichaelHatherly)
• fix(signatures): drop macro line numbers from default values (#238) (@MichaelHatherly)
• feat(templates): add NOTEMPLATE to skip a module's template (#240) (@MichaelHatherly)
• feat(templates): add ABSTRACTTYPES template category (#241) (@MichaelHatherly)
• fix(templates): handle a docstring on a parametric Union alias (#242) (@MichaelHatherly)
• feat(signatures): print keyword argument types in typed signatures (#244) (@MichaelHatherly)
• feat: document struct constructors and field defaults (#245) (@MichaelHatherly)
• feat(signatures): add a returns option to signatures and method lists (#246) (@MichaelHatherly)
• feat(signatures): mark optional arguments with brackets (#247) (@MichaelHatherly)
• fix(signatures): find constructors that write fewer type parameters (#260) (@MichaelHatherly)
• fix(signatures): find the callable method a type's docstring sits on (#261) (@MichaelHatherly)
• feat(signatures): print a macro's signature as its caller writes it (#262) (@MichaelHatherly)
• fix(templates): give MACROS only to docstrings on macros (#263) (@MichaelHatherly)
• fix: print anonymous type parameters as written everywhere (#264) (@MichaelHatherly)
• feat: let readers set the return arrow and signature width (#267) (@MichaelHatherly)
• fix(exports): look up exported names in the latest world (#284) (@MichaelHatherly)
• fix(subtypes): list each subtype under its module's own name (#285) (@MichaelHatherly)
• fix(typedef): print every type parameter as Julia writes it (#286) (@MichaelHatherly)
• fix(imports): reject a docstring object that is not a module (#287) (@MichaelHatherly)
• fix(templates): hold the module's templates, not a copy (#288) (@MichaelHatherly)
• fix(templates): give methods defined through an alias METHODS (#289) (@MichaelHatherly)
• fix(templates): render a templated docstring on an undefined name (#290) (@MichaelHatherly)
• fix(templates): apply templates to a docstring on a bare name (#291) (@MichaelHatherly)
• fix(templates): read a module's templates in the latest world (#292) (@MichaelHatherly)
• fix(signatures): print where bounds with the method's type parameters (#293) (@MichaelHatherly)
• fix(methodlist): list a parametric type's T{P}(...) constructors (#294) (@MichaelHatherly)
• fix(signatures): keep the semicolon on the first line of a wrapped call (#295) (@MichaelHatherly)
• fix(signatures): infer return types of callables and T{P} constructors (#296) (@MichaelHatherly)
• fix(signatures): print inference's type parameter names as their bound (#297) (@MichaelHatherly)
• fix(signatures): leave out a return type inferred as Any (#298) (@MichaelHatherly)
• feat(interface): make the extension API and option types public (#303) (@MichaelHatherly)
• Update version to 0.10.0 (#305) (@MichaelHatherly)

Closed issues:

• Include the defaults for keyword arguments (#19)
• SUBTYPES abbreviation (#47)
• Provide BODY (#54)
• Implement SIGNATURES-like abbreviation for collection of methods (#56)
• destructuring in SIGNATURES show #temp (#67)
• SIGNATURES in composite type definition (#71)
• Creating New Abbreviations (#86)
• Should TYPEDSIGNATURES include types for keyword arguments? (#97)
• ERROR: TypeError: in <:, expected Type, got a value of type TypeVar (#99)
• Default argument value in function documentation (#107)
• Display parametric types in a better way? (#109)
• MODULES key not found for @template (#117)
• Doctest failures (#119)
• Examples of how to use all of the functionality (#122)
• different abbreviations for concrete and abstract types (#147)
• FUNCTIONNAME inside a function that generates the docstring (#149)
• Would it be possible to add a TYPEDMETHODLIST abbreviation (#150)
• Internal errors when (ab)using @template (#151)
• New SUBTYPES exported key (#154)
• FIELDS / TYPEDFIELDS fail on const fields of mutable struct (#155)
• TYPEDSIGNATURES error with @generated functions (#157)
• Feature request: option to override template in specific case (#158)
• Feature request: TYPEDSIGNATURES without output type (#159)
• Format for all docstrings for a particular function (#160)
• what is the recommended way to document arguments used only for their type for SIGNATURES? (#161)
• Parametric constructors cause SIGNATURE and TYPEDSIGNATURE to be empty / wrong (#164)
• Recompilation and load time (#169)
• suggestion: INSTANCES template (#171)
• include defaults for Base.@kwdef structs in FIELDS (or something else) (#182)
• Documentation for latest release is not available (#187)
• Feature Request: Add DocStringExtensions.PUBLIC (#190)
• how to make signaures -> result docstrings (#206)
• make -> customizable (#252)
• SIGNATURES prints an undocumented method for macros, callables and parametric constructors (#253)
• SIGNATURES prints hidden parameters for a constructor called through a type alias (#254)
• SIGNATURES misses a D{T}(...) constructor when D has more type parameters (#255)
• SIGNATURES describes a constructor for a docstring on a callable (e::E)(x) (#256)
• SUBTYPES lists a subtype twice when a const aliases its module (#270)
• TYPEDEF drops the parameters of a parametric primitive type (#271)
• TYPEDEF prints Symbol and Char type parameters without quotes (#272)
• @template skips docstrings in its own begin block (#273)
• @template applies CONSTANTS to methods defined via a const alias (#274)
• Templated docstring on an undefined name throws when rendered (#275)
• @template skips a docstring on a bare existing name (#276)
• @template warns about world age on Julia 1.12+ in a new module (#277)
• TYPEDSIGNATURES writes a Vector{T} bound as Array{T, 1} (#278)
• TYPEDSIGNATURES omits the return type of callables and P{T} constructors (#279)
• METHODLIST omits the P{T}(...) constructors of a parametric struct (#280)
• Wrapped keyword-only signature puts ; on its own line (#281)
• EXPORTS lists nothing when rendered from a stale world on Julia 1.12+ (#282)
• IMPORTS on a non-module crashes Julia (#283)
• Inferred return types print made-up type parameter names like _A (#300)
• Typed signatures print -> Any when inference gives up (#301)