Update user guide

hyperspy · Sep 28, 2023 · 40fb434 · 40fb434
1 parent 6852efb
commit 40fb434
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/doc/user_guide/signal2d.rst b/doc/user_guide/signal2d.rst
@@ -66,16 +66,16 @@ the scheduler of the :ref:`dask backend <dask_backends>`.
 
 .. _signal2D.crop:
 
-Cropping an image
------------------
+Cropping a Signal2D
+-------------------
 
 The :py:meth:`~._signals.signal2d.Signal2D.crop_signal2D` method crops the
 image *in-place* e.g.:
 
 .. code-block:: python
 
     >>> im = hs.datasets.example_signals.object_hologram()
-    >>> imc = im.crop(left=120, top=300, bottom=560) # im is cropped in-place
+    >>> im.crop_signal2D(left=120, top=300, bottom=560) # im is cropped in-place
 
 
 Cropping in HyperSpy is performed using the :ref:`Signal indexing

diff --git a/upcoming_changes/3197.api.rst b/upcoming_changes/3197.api.rst
@@ -1 +1 @@
-Renamed `Signal2D.crop_image` to `Signal2D.crop_signal2D`
+Renamed ``Signal2D.crop_image`` to :meth:`~.api.signals.Signal2D.crop_signal2D`