Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docstrings for recipes are not being parsed correctly #4479

Open
2 tasks done
DanielVandH opened this issue Oct 15, 2024 · 1 comment
Open
2 tasks done

Docstrings for recipes are not being parsed correctly #4479

DanielVandH opened this issue Oct 15, 2024 · 1 comment

Comments

@DanielVandH
Copy link
Contributor

DanielVandH commented Oct 15, 2024

  • what version of Makie are you running? (]st -m Makie)
(jl_EkPgkw) pkg> st -m Makie CairoMakie
Status `C:\Users\djv23\AppData\Local\Temp\jl_EkPgkw\Manifest.toml`
  [13f3f980] CairoMakie v0.12.14
  [ee78f7c6] Makie v0.21.14
  • can you reproduce the bug with a fresh environment ? (]activate --temp; add Makie)
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
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants