Skip to content

Commit be9464a

Browse files
committed
docs: removed some pointers to csep.utils.plots
1 parent 852e68e commit be9464a

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

csep/plots.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -700,7 +700,7 @@ def plot_catalog(
700700
) -> matplotlib.axes.Axes:
701701
"""
702702
Spatial plot of catalog epicenters. Can be plotted over a basemap if desired by passing the
703-
keyword parameters of the function :func:`~csep.utils.plots.plot_basemap`. The size of the
703+
keyword parameters of the function :func:`~csep.plots.plot_basemap`. The size of the
704704
events is automatically scaled according to their magnitude. Fine-tuning of an exponential
705705
sizing function can be set with the parameters ``size``, ``max_size``, ``power``,
706706
``min_val`` and ``max_val``.
@@ -713,7 +713,7 @@ def plot_catalog(
713713
714714
Args:
715715
catalog (CSEPCatalog): Catalog object to be plotted.
716-
basemap (str, optional): Passed to :func:`~csep.utils.plots.plot_basemap` along with
716+
basemap (str, optional): Passed to :func:`~csep.plots.plot_basemap` along with
717717
`kwargs`. Possible values are: `'stock_img'`, `'google-satellite'`,
718718
`'ESRI_terrain'`, `'ESRI_imagery'`, `'ESRI_relief'`, `'ESRI_topo'`, a custom web
719719
service link, or a GeoTiff filepath. Defaults to `None`.
@@ -876,7 +876,7 @@ def plot_gridded_dataset(
876876
"""
877877
Plot spatial gridded dataset such as data from a gridded forecast. Can be plotted over a
878878
basemap by passing the keyword parameters of the function
879-
:func:`~csep.utils.plots.plot_basemap`. The color-map can be fine-tuned using the arguments
879+
:func:`~csep.plots.plot_basemap`. The color-map can be fine-tuned using the arguments
880880
``colorbar``, ``colormap``, ``clim``. An exponential transparency function can be set
881881
with ``alpha`` and ``alpha_exp``.
882882
@@ -894,7 +894,7 @@ def plot_gridded_dataset(
894894
:meth:`~csep.core.regions.CartesianGrid2D.get_cartesian` to convert a 1D array
895895
(whose indices correspond to each spatial cell) to a 2D-square array.
896896
region (CartesianGrid2D): Region in which gridded values are contained.
897-
basemap (str, optional): Passed to :func:`~csep.utils.plots.plot_basemap` along with
897+
basemap (str, optional): Passed to :func:`~csep.plots.plot_basemap` along with
898898
`kwargs`. Possible values are: `'stock_img'`, `'google-satellite'`,
899899
`'ESRI_terrain'`, `'ESRI_imagery'`, `'ESRI_relief'`, `'ESRI_topo'`, a custom web
900900
service link, or a GeoTiff filepath. Defaults to `None`.
@@ -2677,10 +2677,10 @@ def _warning_plot_args(func_name: str):
26772677
Issues a standardized DeprecationWarning for use of 'plot_args' in plotting functions.
26782678
26792679
Args:
2680-
func_name (str): The full function name (e.g., 'csep.utils.plots.plot_catalog').
2680+
func_name (str): The full function name (e.g., 'csep.plots.plot_catalog').
26812681
"""
26822682
base_url = "https://docs.cseptesting.org/reference/generated/"
2683-
doc_url = f"{base_url}/csep.utils.plots.{func_name}.html"
2683+
doc_url = f"{base_url}/csep.plots.{func_name}.html"
26842684

26852685
warnings.warn(
26862686
f"'plot_args' usage is deprecated and will be removed in version 1.0.\n"

0 commit comments

Comments
 (0)