-
-
Notifications
You must be signed in to change notification settings - Fork 105
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
Add scatter matrix reference #689
Conversation
f1be9b8
to
4562221
Compare
Could you look into this @jlstevens please? The only thing I'm unsure about this reference notebook is that I've integrated the docstring by copy pasting it and reformatting it so that it looks better in markdown. Maybe there's a way (a directive?) to have it automatically both pulled from the code base and nicely rendered. |
My vote is for Param and HoloViews to support an HTML rendering of the docs for a Parameterized object, which is something I sketched at holoviz/param#425, and then that could be used here and throughout the docs.I got stuck when realizing that HoloViews' own HTML repr was being overridden by this support, but it's probably not too big a job to fix that and then improve the representation so that it works well both as docs and in Jupyter, just like xarray does. Seems like an easy win and a major step forward in usability! |
Oh yes that would be great except that in this particular case |
Good point, but yes, a ParameterizedFunction then, so that all documented stuff could have a similar repr. |
@maximlt I'll have a look at this shortly. |
Looks great! Two comments:
|
Thanks for your review Jean-Luc! I'll make the small edit you suggest at the start. On your second point, I've actually just exposed in the docs the parameters that are in the function signature and documented in the docstring. But thinking about it more this doesn't seem like a good long-term solution, I've seen in Panel how difficult it is to properly sync the Parameters |
I'm going ahead and merging. The last change I've made updates the intro as suggested in the review. I've removed the parameters description, even if it was somehow nice to have I believe it wasn't the right place and time to do this change. This should happen across the whole documentation once a better system to document the API parameters is found. |
This PR adds a reference page for the
scatter_matrix
plots. It also fixes to docstring of this function to reflect the fact thattools
only support alist
of tools.