MakieOrg / Makie.jl

Interactive data visualizations and plotting in Julia
https://docs.makie.org/stable
MIT License
2.4k stars 307 forks source link

Docstrings for recipes are not being parsed correctly #4479

Open DanielVandH opened 2 hours ago

DanielVandH commented 2 hours ago
julia> versioninfo()
Julia Version 1.11.0
Commit 501a4f25c2 (2024-10-07 11:40 UTC)
Build Info:
  Official https://julialang.org/ release
Platform Info:
  OS: Windows (x86_64-w64-mingw32)
  CPU: 24 × AMD Ryzen Threadripper PRO 7945WX 12-Cores
  WORD_SIZE: 64
  LLVM: libLLVM-16.0.6 (ORCJIT, znver4)
Threads: 1 default, 0 interactive, 1 GC (on 24 virtual cores)

The top of the docstrings are messed up (the rest of the docstrings showing the arguments etc are fine, it's just the top)

help?> scatter
search: scatter scatter! Scatter meshscatter MeshScatter isletter meshscatter! scatterlines scale! Pattern scatterlines!

  Base.Docs.DocStr(svec(" scatter(positions)\n scatter(x, y)\n scatter(x, y, z)\n\nPlots a marker for each element in
  (x, y, z), (x, y), or positions.\n"), nothing, Dict{Symbol, Any}(:typesig => Union{}, :module => MakieCore,
  :linenumber => 440, :binding => MakieCore.##261, :path =>
  "C:\Users\djv23\.julia\packages\MakieCore\NeQjl\src\basic_plots.jl"))## Plot type The plot type alias for the
  scatter function is Scatter.
help?> mesh
search: mesh mesh! Mesh esc less hash sech cosh

  Base.Docs.DocStr(svec(" mesh(x, y, z)\n mesh(meshobject)\n mesh(x, y, z, faces)\n mesh(xyz, faces)\n\nPlots a 3D or
  2D mesh. Supported `meshobjects includeMeshtypes from
  [GeometryBasics.jl](https://github.com/JuliaGeometry/GeometryBasics.jl).\n"), nothing, Dict{Symbol, Any}(:typesig =>
  Union{}, :module => MakieCore, :linenumber => 412, :binding => MakieCore.##256, :path =>
  "C:\\Users\\djv23\\.julia\\packages\\MakieCore\\NeQjl\\src\\basic_plots.jl"))## Plot type The plot type alias for
  themeshfunction isMesh`.
jkrumbiegel commented 2 hours ago

Yeah something in the docs internals changed in 1.11 which I've been using for generating docstrings..