search

MakieOrg / Makie.jl

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

Document examples for each method and option #876

Closed jtrakk closed 3 weeks ago

jtrakk commented 3 years ago

It often happens that I look at the docs for a plotting function and I see several methods and options that look relevant to what I want but (1) I'm not sure if it's the right option, and (2) when I use it and it doesn't do what I expected, I'm not sure if it's supposed to look like that.

It would be helpful to have some examples of every method and option. I'm not sure what the best UI for that is, since it's a lot of examples. Maybe each entry in the options list could link to some plots with different values set for the options.

For example, each of these rows could have a link to a corresponding plot.

  arrowcolor   :black                          
  arrowhead    AbstractPlotting.Automatic()
  arrowsize    0.3
  arrowtail    "nothing"
  colormap     :viridis
  lengthscale  1.0f0
  linecolor    :black
  linestyle    "nothing"
  linewidth    1
  normalize    false
  scale        Float32[1.0, 1.0, 1.0]
jkrumbiegel commented 3 years ago

Part of the short method descriptions was that I started off from the old format, where there was just one huge page. I'm splitting this out into separate pages so each method has room to have its attributes explored more. https://github.com/JuliaPlots/AbstractPlotting.jl/pull/659

ffreyer commented 3 weeks ago

Closing as outdated/fixed because attributes are actually documented now