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.

Sign up for GitHub

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

Jump to bottom

DOC: missing documentation on extensibility of plot annotation methods #4072

Closed
neutrinoceros opened this issue Aug 11, 2022 · 0 comments · Fixed by #4080
Closed

DOC: missing documentation on extensibility of plot annotation methods #4072

neutrinoceros opened this issue Aug 11, 2022 · 0 comments · Fixed by #4080
Labels
docs

Comments

@neutrinoceros
Copy link
Member

neutrinoceros commented Aug 11, 2022 •
edited
Loading

The plot annotation methods (PWViewerMPL.annotate_*), a.k.a plot callbacks can be extended with no edits to yt's source code by subclassing the PlotCallback class.
This is very much intentional/supported behaviour (e.g. yt_astro_analysis relies on this to define the annotate_halos method), however it is not currently documented (as of yt 4.0.5)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DOC: document plot callbacks extensibility neutrinoceros/yt
1 participant
@neutrinoceros