Skip to content

update annotate_contours docs to avoid deprecated API #4566

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

Merged
merged 1 commit into from
Jul 7, 2023
Merged

update annotate_contours docs to avoid deprecated API #4566

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/source/visualizing/callbacks.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,14 +247,14 @@ Clump Finder Callback
Overplot Contours
~~~~~~~~~~~~~~~~~

.. function:: annotate_contour(self, field, ncont=5, factor=4, take_log=False,\
.. function:: annotate_contour(self, field, levels=5, factor=4, take_log=False,\
clim=None, plot_args=None, label=False, \
text_args=None, data_source=None)

(This is a proxy for
:class:`~yt.visualization.plot_modifications.ContourCallback`.)

Add contours in ``field`` to the plot. ``ncont`` governs the number of
Add contours in ``field`` to the plot. ``levels`` governs the number of
contours generated, ``factor`` governs the number of points used in the
interpolation, ``take_log`` governs how it is contoured and ``clim`` gives
the (upper, lower) limits for contouring.
Expand Down