Skip to content

Improve the documentation of the plot methods #1536

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

Open
31 tasks
Tracked by #1562 ...
maximlt opened this issue Apr 2, 2025 · 0 comments · May be fixed by #1548
Open
31 tasks
Tracked by #1562 ...

Improve the documentation of the plot methods #1536

maximlt opened this issue Apr 2, 2025 · 0 comments · May be fixed by #1548
Assignees

Comments

@maximlt
Copy link
Member

maximlt commented Apr 2, 2025

The plot methods will soon be documented part of the API reference. Underneath their signature and parameter description, a series of examples should be added to demonstrate the effects of the kwargs specific to each method (e.g. bands for rgb).

In the process, we will likely need to fix/improve the docstring (summary, parameter description, parameter types). Let's do it simultaneously.

Some guidelines:

  • Only use hvsampledata
  • Write reproducible snippets (code block that contains all the code needed for the plot to be displayed, including imports)
  • Include Pandas and Xarray examples when possible
  • Possible to display how to use multiple kwargs in a single plot

Sorted from the highest to lowest priority (based on GoatCounter pageviews):

@maximlt maximlt added the TRIAGE Requires triage or initial assessment label Apr 2, 2025
@maximlt maximlt added type: docs and removed TRIAGE Requires triage or initial assessment labels Apr 2, 2025
@Azaya89 Azaya89 moved this from Todo to In Progress in NF SDG 2024 Round 3 - hvPlot docs Apr 17, 2025
@Azaya89 Azaya89 linked a pull request Apr 17, 2025 that will close this issue
32 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

Successfully merging a pull request may close this issue.

2 participants