Skip to content
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

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

Open
lukashergt opened this issue Aug 16, 2022 · 1 comment
Labels
docs Documentation upgrades
Milestone

Comments

@lukashergt
Copy link
Collaborator

lukashergt commented Aug 16, 2022

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 williamjameshandley modified the milestones: 2.0.1, 2.1.0 Aug 17, 2022
@williamjameshandley
Copy link
Collaborator

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

@williamjameshandley williamjameshandley added the docs Documentation upgrades label Apr 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation upgrades
Projects
None yet
Development

No branches or pull requests

2 participants