Skip to content

The new visualization module could use a user guide and/or migration guide. #953

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

Closed
conradhaupt opened this issue Oct 26, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@conradhaupt
Copy link
Contributor

With the addition of the new visualization submodule in #902, the need for a guide on plotting figures in analysis classes has increased. Previously, developers of analysis classes used Matplotlib in their own independent way. The new module means that users are discouraged from using Matplotlib directly, and instead to use subclasses of BasePlotter. However, the usage of these classes is only documented in the API reference (i.e., docstrings) and not as a separate user guide or tutorial.

@conradhaupt conradhaupt added the documentation Improvements or additions to documentation label Oct 26, 2022
@coruscating
Copy link
Collaborator

Tutorial added in #983.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants