search

handley-lab / anesthetic

Nested Sampling post-processing and plotting
https://anesthetic.readthedocs.io
MIT License
57 stars 16 forks source link

`samples.plot.kde_2d()` should show the documentation from `kde_contour_plot_2d` #220

Open lukashergt opened 2 years ago

lukashergt commented 2 years ago

Currently the docstring of samples.plot.kde_2d() reads as

"""KDE plot: See anesthetic.plot.kde_contour_plot_2d."""

I think this is not good enough. For samples.plot_2d() it is difficult to list all the possible kwargs of the various different plot kinds, but we need some easy accessible way to check for the possible kwargs for kde_2d, namely all the kwargs listed in kde_contour_plot_2d. My standard approach would be to write samples.kde_2d( and then press Shift+Tab to get function signature and docstring.

williamjameshandley commented 2 years ago

Agreed -- we could use this as a test-bed for documentation re-use, which should still show up in your autocompletion.