search

holoviz / holoviews

With Holoviews, your data visualizes itself.
https://holoviews.org
BSD 3-Clause "New" or "Revised" License
2.69k stars 403 forks source link

hv.help should show the element __doc__ #5421

Open MarcSkovMadsen opened 2 years ago

MarcSkovMadsen commented 2 years ago

I've been strugling with Scatter3D in other issues. Now I found one of the reasons: hv.help is broken and does not include the docstring or Parameters of the Scatter3D effectively meaning you have to guess how to use it.

hv.help

image

hv.Scatter3D.__doc__

The below is missing in hv.help.

image

Related

jlstevens commented 1 year ago

Using .__doc__ is always available so I don't consider this a bug (hv.help is more focused on the holoviews specific concepts, such as the options system). However, it is a reasonable suggestion for an enhancement.

jbednar commented 1 year ago

I'd consider this a bug! The hv-specific options should be in addition to the docstring, not instead of.