Skip to content

Improve the documentation of the plot methods #1536

@maximlt

Description

@maximlt

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):

Metadata

Metadata

Labels

No labels
No labels

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions