Skip to content

[doctest] StackOverflowError in docstring involving DocStringExtensions.TypedMethodSignatures in Julia v1.11 #2892

@giordano

Description

@giordano

With Breeze@d51d279ba7dae0a768aafad593e79dd4d4117e65 and Julia v1.11.9 (note: only with this version of Julia) we often (but not always!) get on CI the following error in doctests:

│ ┌ Error: parsedoc failed to parse a docstring into Markdown. This indicates a problem with the docstring.
│ │   exception = StackOverflowError:
│ │   docstr.data =
│ │    Dict{Symbol, Any} with 5 entries:
│ │      :typesig => NTuple{5, Any}
│ │      :module => Breeze.ParcelModels
│ │      :linenumber => 378
│ │      :binding => Breeze.ParcelModels.set_temperature_from_potential_temperature!
│ │      :path => "/Users/runner/work/Breeze.jl/Breeze.jl/src/ParcelModels/parcel_dynamics.jl"
│ │   collect(docstr.text) =
│ │    2-element Vector{Any}:
│ │     DocStringExtensions.TypedMethodSignatures()
│ │     "\n\nSet temperature field from potential temperature, using proper thermodynamic relations.\n"
│ │   docstr.object = nothing
│ └ @ Documenter.DocSystem ~/.julia/packages/Documenter/AXNMp/src/DocSystem.jl:289

This points to https://github.com/NumericalEarth/Breeze.jl/blob/d51d279ba7dae0a768aafad593e79dd4d4117e65/src/ParcelModels/parcel_dynamics.jl#L378-L383. I haven't been able to reproduce this error when running the doctests locally with Julia v1.11.9, I have no clue of where the error comes from, nor of what it could possibly mean.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions