Skip to content

Commit 145be85

Browse files
committed
refactor: update stale figure_plots docstring cross-references in Examples
Replace all :meth:`~anyplotlib.figure_plots.Plot1D.*` and :meth:`~anyplotlib.figure_plots.Plot2D.*` Sphinx cross-reference strings in the Examples directory with the correct new module paths (anyplotlib.plot1d.Plot1D and anyplotlib.plot2d.Plot2D) following the project reorganization that deleted figure_plots.py.
1 parent c87f4c2 commit 145be85

18 files changed

Lines changed: 20 additions & 20 deletions

Examples/Interactive/plot_interactive_fft.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@
1010
* The left panel shows a synthetic real-space image (a periodic lattice with
1111
noise, similar to an atomic-resolution STEM image).
1212
* A yellow rectangle widget marks the region-of-interest (ROI).
13-
* Whenever the ROI is moved or resized the :meth:`~anyplotlib.figure_plots.Plot2D.on_release`
13+
* Whenever the ROI is moved or resized the :meth:`~anyplotlib.plot2d.Plot2D.on_release`
1414
callback re-computes ``numpy.fft.fft2`` on the cropped pixels, applies a
1515
Hann window to reduce edge ringing, takes the log-magnitude, and pushes the
1616
result into the right panel with
17-
:meth:`~anyplotlib.figure_plots.Plot2D.update`.
18-
* A second :meth:`~anyplotlib.figure_plots.Plot2D.on_change` callback updates
17+
:meth:`~anyplotlib.plot2d.Plot2D.update`.
18+
* A second :meth:`~anyplotlib.plot2d.Plot2D.on_change` callback updates
1919
a lightweight text readout (ROI size in pixels) on every drag frame without
2020
re-running the FFT.
2121

Examples/Interactive/plot_point_widget.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
* **Derivative** (central finite difference): ``dy/dx ≈ [f(xq+h) − f(xq−h)] / 2h``
2525
* **Tangent line**: ``y_tan(x) = yq + slope · (x − xq)``
2626
27-
The tangent line is added with :meth:`~anyplotlib.figure_plots.Plot1D.add_line`
27+
The tangent line is added with :meth:`~anyplotlib.plot1d.Plot1D.add_line`
2828
and the previous one is removed, so only one tangent is shown at a time.
2929
3030
.. note::

Examples/Markers/plot_arrows.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
======
44
55
Draw vector arrows on a 2-D image with
6-
:meth:`~anyplotlib.figure_plots.Plot2D.add_arrows`.
6+
:meth:`~anyplotlib.plot2d.Plot2D.add_arrows`.
77
Use ``markers["arrows"]["name"].set(...)`` to update them live.
88
"""
99
import numpy as np

Examples/Markers/plot_circles.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
=======
44
55
Mark circular features on a 2-D image with
6-
:meth:`~anyplotlib.figure_plots.Plot2D.add_circles`.
6+
:meth:`~anyplotlib.plot2d.Plot2D.add_circles`.
77
Use ``markers["circles"]["name"].set(...)`` to update them live.
88
"""
99
import numpy as np

Examples/Markers/plot_ellipses.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
========
44
55
Draw ellipses on a 2-D image with
6-
:meth:`~anyplotlib.figure_plots.Plot2D.add_ellipses`.
6+
:meth:`~anyplotlib.plot2d.Plot2D.add_ellipses`.
77
Use ``markers["ellipses"]["name"].set(...)`` to update them live.
88
"""
99
import numpy as np

Examples/Markers/plot_horizontal_lines.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
================
44
55
Draw static horizontal threshold lines on a 1-D plot with
6-
:meth:`~anyplotlib.figure_plots.Plot1D.add_hlines`.
6+
:meth:`~anyplotlib.plot1d.Plot1D.add_hlines`.
77
Use ``markers["hlines"]["name"].set(...)`` to update them live.
88
"""
99
import numpy as np

Examples/Markers/plot_line_segments.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
=============
44
55
Draw line segments on a 2-D image with
6-
:meth:`~anyplotlib.figure_plots.Plot2D.add_lines`.
6+
:meth:`~anyplotlib.plot2d.Plot2D.add_lines`.
77
Use ``markers["lines"]["name"].set(...)`` to update them live.
88
"""
99
import numpy as np

Examples/Markers/plot_points.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
======
44
55
Mark specific (x, y) positions on a 1-D plot with
6-
:meth:`~anyplotlib.figure_plots.Plot1D.add_points`.
6+
:meth:`~anyplotlib.plot1d.Plot1D.add_points`.
77
Use ``markers["points"]["name"].set(...)`` to update them live.
88
"""
99
import numpy as np

Examples/Markers/plot_polygons.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
========
44
55
Draw closed polygons on a 2-D image with
6-
:meth:`~anyplotlib.figure_plots.Plot2D.add_polygons`.
6+
:meth:`~anyplotlib.plot2d.Plot2D.add_polygons`.
77
Use ``markers["polygons"]["name"].set(...)`` to update them live.
88
"""
99
import numpy as np

Examples/Markers/plot_rectangles.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
==========
44
55
Draw bounding boxes on a 2-D image with
6-
:meth:`~anyplotlib.figure_plots.Plot2D.add_rectangles`.
6+
:meth:`~anyplotlib.plot2d.Plot2D.add_rectangles`.
77
Use ``markers["rectangles"]["name"].set(...)`` to update them live.
88
"""
99
import numpy as np

0 commit comments

Comments
 (0)