DOC: fix references to ProjectionPlot, which is now a function (used …

…to be a class)
yt-project · Jul 24, 2021 · f441515 · f441515
1 parent e6e5690
commit f441515
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 8 deletions.
diff --git a/doc/source/analyzing/objects.rst b/doc/source/analyzing/objects.rst
@@ -44,7 +44,7 @@ Alternatively, we could create a sphere object of radius 1 kpc on location
 
 After an object has been created, it can be used as a data_source to certain
 tasks like ``ProjectionPlot`` (see
-:class:`~yt.visualization.plot_window.ProjectionPlot`), one can compute the
+:func:`~yt.visualization.plot_window.ProjectionPlot`), one can compute the
 bulk quantities associated with that object (see :ref:`derived-quantities`),
 or the data can be examined directly. For example, if you want to figure out
 the temperature at all indexed locations in the central sphere of your

diff --git a/doc/source/cookbook/complex_plots.rst b/doc/source/cookbook/complex_plots.rst
@@ -34,7 +34,7 @@ with a fourth entering for particle data that is deposited onto a mesh
 is inherited by
 :class:`~yt.visualization.plot_window.AxisAlignedSlicePlot`,
 :class:`~yt.visualization.plot_window.OffAxisSlicePlot`,
-:class:`~yt.visualization.plot_window.ProjectionPlot`, and
+:func:`~yt.visualization.plot_window.ProjectionPlot`, and
 :class:`~yt.visualization.plot_window.OffAxisProjectionPlot`.  This
 controls the number of resolution elements in the
 :class:`~yt.visualization.fixed_resolution.FixedResolutionBuffer`,

diff --git a/doc/source/cookbook/simple_plots.rst b/doc/source/cookbook/simple_plots.rst
@@ -105,7 +105,7 @@ Making Plots of Multiple Fields Simultaneously
 
 By adding multiple fields to a single
 :class:`~yt.visualization.plot_window.SlicePlot` or
-:class:`~yt.visualization.plot_window.ProjectionPlot` some of the overhead of
+:func:`~yt.visualization.plot_window.ProjectionPlot` some of the overhead of
 creating the data object can be reduced, and better performance squeezed out.
 This recipe shows how to add multiple fields to a single plot.
 See :ref:`slice-plots` and :ref:`projection-plots` for more information.

diff --git a/doc/source/reference/changelog.rst b/doc/source/reference/changelog.rst
@@ -2219,7 +2219,7 @@ Most Visible Improvements
 Other Changes
 ^^^^^^^^^^^^^
 
- * :class:`~yt.visualization.plot_window.ProjectionPlot` and
+ * :func:`~yt.visualization.plot_window.ProjectionPlot` and
    :class:`~yt.visualization.plot_window.SlicePlot` supplant the functionality
    of PlotCollection.
  * Camera path creation from keyframes and splines

diff --git a/doc/source/visualizing/callbacks.rst b/doc/source/visualizing/callbacks.rst
@@ -13,7 +13,7 @@ lines, text, markers, streamlines, velocity vectors, contours, and more.
 
 Callbacks can be applied to plots created with
 :class:`~yt.visualization.plot_window.SlicePlot`,
-:class:`~yt.visualization.plot_window.ProjectionPlot`,
+:func:`~yt.visualization.plot_window.ProjectionPlot`,
 :class:`~yt.visualization.plot_window.OffAxisSlicePlot`, or
 :class:`~yt.visualization.plot_window.OffAxisProjectionPlot` by calling
 one of the ``annotate_`` methods that hang off of the plot object.

diff --git a/doc/source/visualizing/plots.rst b/doc/source/visualizing/plots.rst
@@ -56,7 +56,7 @@ generating annotated 2D visualizations of simulation data.  You can create a
 supplying a dataset, a list of fields to plot, and a plot center to
 create a :class:`~yt.visualization.plot_window.AxisAlignedSlicePlot`,
 :class:`~yt.visualization.plot_window.OffAxisSlicePlot`,
-:class:`~yt.visualization.plot_window.ProjectionPlot`, or
+:func:`~yt.visualization.plot_window.ProjectionPlot`, or
 :class:`~yt.visualization.plot_window.OffAxisProjectionPlot`.
 
 Plot objects use yt data objects to extract the maximum resolution
@@ -296,7 +296,7 @@ Using a fast adaptive projection, yt is able to quickly project
 simulation data along the coordinate axes.
 
 Projection plots are created by instantiating a
-:class:`~yt.visualization.plot_window.ProjectionPlot` object.  For
+:func:`~yt.visualization.plot_window.ProjectionPlot` object.  For
 example:
 
 .. python-script::
@@ -322,7 +322,7 @@ the plot to a png image file.
 Like :ref:`slice-plots`, annotations and modifications can be applied
 after creating the ``ProjectionPlot`` object.  Annotations are
 described in :ref:`callbacks`.  See
-:class:`~yt.visualization.plot_window.ProjectionPlot` for the full
+:func:`~yt.visualization.plot_window.ProjectionPlot` for the full
 class description.
 
 If you want to project through a subset of the full dataset volume,