Skip to content

Commit

Permalink
Backport PR yt-project#4566: update annotate_contours docs to avoid d…
Browse files Browse the repository at this point in the history
…eprecated API
  • Loading branch information
neutrinoceros authored and meeseeksmachine committed Jul 7, 2023
1 parent 988a355 commit e298b9b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/source/visualizing/callbacks.rst
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

0 comments on commit e298b9b

Please sign in to comment.