Skip to content

Update DocStringExtensions requirement from 0.9 to 0.9, 0.10 - #50

Merged
JamesWrigley merged 1 commit into
masterfrom
dependabot/julia/DocStringExtensions-0.9-and-0.10
Oct 18, 2026
Merged

Update DocStringExtensions requirement from 0.9 to 0.9, 0.10#50
JamesWrigley merged 1 commit into
masterfrom
dependabot/julia/DocStringExtensions-0.9-and-0.10

Conversation

@dependabot

@dependabot dependabot Bot commented on behalf of github Oct 17, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Updates the requirements on DocStringExtensions to permit the latest version.

Release notes

Sourced from DocStringExtensions's releases.

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:

... (truncated)

Changelog

Sourced from DocStringExtensions's changelog.

v0.10.0 - 2026-10-14

Breaking

  • @template rejects a category no docstring belongs to, such as a misspelled name, with an ArgumentError. It used to store a template that never applied, so a package with such a category now fails to precompile until the category is corrected or removed (#223)
  • @template throws an ArgumentError for a template string without $(DOCSTRING), including a plain string literal, when the template is defined. Some of these templates used to load and fail with a MethodError only when Julia displayed a docstring. A package that defines one now fails to precompile (#151)
  • More docstrings get a template, and some get a different one. A docstring now gets its template when it sits in the same begin block as the @template (#288), documents a bare existing name such as "..." f (#291), or documents a parametric type's constructor (#226). A method defined through a const alias gets METHODS where it got CONSTANTS (#289). A function named like a macro, such as var"@f", no longer gets MACROS (#263). Bindings documented together each get their own category's template (#210). Where a docstring repeats by hand what its template prints, the text now appears twice

Added

  • Add TYPEDMETHODLIST, which lists methods like METHODLIST but with argument and return types. TypedMethodList(returns = false) leaves out the return types (#150, #197)
  • Add TypedMethodSignatures(returns = false), which renders typed signatures without return types (#159, #179)
  • Add a returns option to MethodSignatures and MethodList that follows each signature with its inferred return type. MethodSignatures and TypedMethodSignatures also take a string, such as returns = "success::Bool", which they print after -> in place of the inferred type (#206, #246)
  • Add the DOCSTRINGEXTENSIONS_RETURN_ARROW and DOCSTRINGEXTENSIONS_SIGNATURE_WIDTH environment variables. A reader sets them to change the arrow before return types, such as to →, and the width at which a signature wraps to one argument per line, 60 by default (#252, #267)
  • Add a defaults = true option to MethodSignatures and TypedMethodSignatures that prints default argument values, with the methods generated for positional defaults collapsed into one signature (#19, #107, #194)
  • Add a defaults = :brackets option to MethodSignatures and TypedMethodSignatures. It prints the collapsed signature without default values. Each optional positional argument appears in brackets. Any other symbol passed as defaults throws an ArgumentError (#206, #247)
  • Add PUBLIC to list a module's public names, both exported and declared public (#190)
  • Add INSTANCES to list the instances of an enum with their values. It supports @enum and EnumX.jl's @enumx (#171)
  • Add SUBTYPES to list the direct subtypes of a type as links. It lists only subtypes defined in the type's own module or a module inside it (#47, #154, #227)
  • Add BODY to print the body of the documented method definition as a Julia code block (#54, #237)
  • Add NOTEMPLATE, which stops a module's @template applying to the docstring it appears in. TemplateOverride(category) applies the template for another category instead (#158, #240)
  • Add the ABSTRACTTYPES template category for abstract types. A module without one documents abstract types with its TYPES template, as before (#147, #241)
  • SIGNATURES and TYPEDSIGNATURES in the docstring of a macro print it as its caller writes it, such as @m a b. The __source__ and __module__ arguments and the inferred return type are left out. They printed nothing before. METHODLIST and TYPEDMETHODLIST list a macro the same way. For a vararg macro they printed its hidden arguments, and for any other macro nothing (#262)
  • SIGNATURES and TYPEDSIGNATURES in the docstring of a struct list the constructors its definition creates. They printed nothing before (#71, #245)
  • Declare the interface for writing an abbreviation public on Julia 1.11 and later: Abbreviation, format and interpolation. A new guide covers it (#86, #303)
  • Declare the types that take abbreviation options public on Julia 1.11 and later, such as MethodSignatures and TypeFields. Each one appears on its topic's reference page (#303)
  • Add TypeFields(; types, defaults), whose keywords match the other option types (#303)

Changed

  • Signatures leave out a return type inferred as Any, as they already did for Nothing. -> Any says only that inference could not work out the type (#301, #298)
  • The manual splits into Examples and Reference sections with one page per topic. Each example page prints its source above the rendered docstrings, and new pages cover PUBLIC, INSTANCES, and @template with DOCSTRING. The package docstring is rewritten. A Setup page covers adding the package, templates, and Documenter. The docstrings of the package, @template and every abbreviation except README and LICENSE carry examples as doctests, which the docs build checks against the real output. They replace hand-written samples that had drifted from it (#122, #215)
  • SIGNATURES prints an unnamed argument with a declared type as ::T, as TYPEDSIGNATURES does, so foo(::Val{N}) no longer prints as foo(_). An untyped unnamed argument still prints as _ (#161, #235)
  • TYPEDSIGNATURES and TYPEDMETHODLIST print the declared type of each keyword argument, such as f(x; n::Int64). An untyped keyword and a kwargs... keyword print without one (#97, #244)
  • FIELDS and TYPEDFIELDS print each field's default value, such as retries::Int64 = 3, for structs defined with Base.@kwdef or a macro that uses the same syntax. TypeFields(defaults = false) hides them (#182, #245)
  • @template applies a template when its docstring is defined, not when it is displayed, so a templated docstring no longer stores the documented expression in the package image. A docstring for a binding that does not exist yet keeps its template until display. Bindings documented together, such as @doc "..." (f, T), each get the template for their own category, where they all used the last binding's (#210)

Deprecated

  • TypeFields(types::Bool) is deprecated in favour of TypeFields(types = ...) (#303)

Fixed

  • Fix inferred return types printing the names inference gives the type parameters it cannot work out, such as -> Pair{_A, Int} where _A. They print as their bound, -> Pair{<:Any, Int}, on Julia 1.3 and later (#300, #297)
  • Fix TYPEDSIGNATURES leaving out the return type of a callable such as (e::E)(x) and of a constructor written T{P}(...). Before Julia 1.6 they still print without one (#279, #296)
  • Fix a wrapped signature with only keyword arguments printing ; alone on its own line. It prints f(; on the first line. A signature without arguments no longer wraps, so a long return type follows f() (#281, #295)
  • Fix METHODLIST and TYPEDMETHODLIST in a parametric type's docstring leaving out the constructors written T{P}(...) (#280, #294)
  • Fix signatures printing a where bound that names another type parameter with Array{T, 1} where the source writes Vector{T}, such as S<:Vector{T} (#278, #293)
  • Fix a world-age warning on Julia 1.12 and later when @template and a docstring expand together from running code, such as in one macroexpand call. Under --depwarn=error the docstring lost its template (#277, #292)
  • Fix @template skipping a docstring on a bare existing name, such as "..." f after function f end. The dotted form "..." M.f already got its template (#276, #291)

... (truncated)

Commits
  • 2ce303a Merge pull request #305 from JuliaDocs/mh/release-0.10.0
  • 1eae881 Update version to 0.10.0
  • 170f571 Merge pull request #307 from JuliaDocs/mh/fix-type-parameters
  • a75fe18 ci: fail the test jobs on any deprecation warning
  • 694e005 test(base_assumptions): read Type{A}'s parameter through the shim
  • 1f6d09a Merge pull request #306 from JuliaDocs/mh/docs-instantiate
  • b28f4b4 ci(docs): build the docs against a cloned Documenter
  • aa4ede4 Merge pull request #303 from JuliaDocs/mh/public-extension-api
  • e2ee2b3 Merge pull request #304 from JuliaDocs/mh/docs-fixes
  • a54bfc7 docs(signatures): state the printing rules in the docstrings
  • Additional commits viewable in compare view

@dependabot dependabot Bot added dependencies Pull requests that update a dependency file julia Pull requests that update julia code labels Oct 17, 2026
@codecov

codecov Bot commented Oct 17, 2026 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.91%. Comparing base (451756e) to head (bc9875e).

Additional details and impacted files 
@@            Coverage Diff             @@
##           master      #50      +/-   ##
==========================================
+ Coverage   81.87%   81.91%   +0.04%     
==========================================
  Files          10       10              
  Lines        2273     2273              
==========================================
+ Hits         1861     1862       +1     
+ Misses        412      411       -1

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@dependabot
dependabot Bot force-pushed the dependabot/julia/DocStringExtensions-0.9-and-0.10 branch from 89b8760 to 54af9c0 Compare October 18, 2026 09:00
@dependabot @JamesWrigley
Update DocStringExtensions compat
bc9875e 
Signed-off-by: dependabot[bot] <support@github.com>
@JamesWrigley
JamesWrigley force-pushed the dependabot/julia/DocStringExtensions-0.9-and-0.10 branch from 54af9c0 to bc9875e Compare October 18, 2026 10:05
@JamesWrigley
JamesWrigley merged commit d4d8119 into master Oct 18, 2026
9 checks passed
@JamesWrigley
JamesWrigley deleted the dependabot/julia/DocStringExtensions-0.9-and-0.10 branch October 18, 2026 10:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

dependencies Pull requests that update a dependency file julia Pull requests that update julia code

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@JamesWrigley