Help insufficient, valid values of attributes nowhere documented

MakieOrg / Makie.jl

Interactive data visualizations and plotting in Julia

https://docs.makie.org/stable

MIT License

2.41k stars 312 forks source link

Help insufficient, valid values of attributes nowhere documented #3730

Open ufechner7 opened 7 months ago

ufechner7 commented 7 months ago

For example:

help?> Menu.alignmode
  Default value: Inside()

  The alignment of the menu in its suggested bounding box.

The default value is mentioned, but nowhere a hint which other values are allowed...

This is is the same for many other attributes. I try to compile an (incomplete) list:

[ ] alignmode
[ ] bbox
[ ] font
[ ] halign
[ ] height
[ ] labelcolor (probably holds for all colors, valid values nowhere listed)
[ ] padding
[ ] valign
[ ] width

asinghvi17 commented 7 months ago

I wonder if one could define hooks for extra, common info when displaying docs in the REPL. Maybe by dispatching on Val{property}()?

ufechner7 commented 7 months ago

I wonder if one could define hooks for extra, common info when displaying docs in the REPL. Maybe by dispatching on Val{property}()?

Good idea, but in the html documentation it should be possible to click on any of the attributes to get a list of valid values. Would that be possible with the currently used documentation system?