From fc22e9a32f5cd475a108b840b1329511545c2cb4 Mon Sep 17 00:00:00 2001 From: Keurfon Luu Date: Tue, 13 Dec 2022 17:41:05 -0800 Subject: [PATCH] fix typos --- bruces/_catalog.py | 8 ++++---- bruces/decluster/_helpers.py | 8 ++++---- bruces/decluster/nearest_neighbor/_nearest_neighbor.py | 6 +++--- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/bruces/_catalog.py b/bruces/_catalog.py index 1233a11..a3d6a45 100644 --- a/bruces/_catalog.py +++ b/bruces/_catalog.py @@ -193,13 +193,13 @@ def decluster(self, algorithm="nearest-neighbor", return_indices=False, **kwargs w : scalar, optional, default 1.0 Only if ``algorithm = "nearest-neighbor"``. Magnitude weighting factor (usually b-value). use_depth : bool, optional, default False - Only if ``algorithm = "nearest-neighbor"`` and ``method = "thinning"`. If `True`, consider depth in interevent distance calculation. + Only if ``algorithm = "nearest-neighbor"``. If `True`, consider depth in interevent distance calculation. eta_0 : scalar or None, optional, default None - Only if ``algorithm = "nearest-neighbor"`` and ``method = "thinning"`. Initial cutoff threshold. If `None`, invoke :meth:`bruces.Catalog.fit_cutoff_threshold`. + Only if ``algorithm = "nearest-neighbor"`` and ``method = "thinning"``. Initial cutoff threshold. If `None`, invoke :meth:`bruces.Catalog.fit_cutoff_threshold`. alpha_0 : scalar, optional, default 1.5 - Only if ``algorithm = "nearest-neighbor"`` and ``method = "thinning"`. Cluster threshold. + Only if ``algorithm = "nearest-neighbor"`` and ``method = "thinning"``. Cluster threshold. M : int, optional, default 16 - Only if ``algorithm = "nearest-neighbor"`` and ``method = "thinning"`. Number of reshufflings. + Only if ``algorithm = "nearest-neighbor"`` and ``method = "thinning"``. Number of reshufflings. seed : int or None, optional, default None Only if ``algorithm = "nearest-neighbor"``. Seed for random number generator. rfact : int, optional, default 10 diff --git a/bruces/decluster/_helpers.py b/bruces/decluster/_helpers.py index dc2b953..50a8bb1 100644 --- a/bruces/decluster/_helpers.py +++ b/bruces/decluster/_helpers.py @@ -49,13 +49,13 @@ def decluster(catalog, algorithm="nearest-neighbor", return_indices=False, **kwa w : scalar, optional, default 1.0 Only if ``algorithm = "nearest-neighbor"``. Magnitude weighting factor (usually b-value). use_depth : bool, optional, default False - Only if ``algorithm = "nearest-neighbor"`` and ``method = "thinning"`. If `True`, consider depth in interevent distance calculation. + Only if ``algorithm = "nearest-neighbor"``. If `True`, consider depth in interevent distance calculation. eta_0 : scalar or None, optional, default None - Only if ``algorithm = "nearest-neighbor"`` and ``method = "thinning"`. Initial cutoff threshold. If `None`, invoke :meth:`bruces.Catalog.fit_cutoff_threshold`. + Only if ``algorithm = "nearest-neighbor"`` and ``method = "thinning"``. Initial cutoff threshold. If `None`, invoke :meth:`bruces.Catalog.fit_cutoff_threshold`. alpha_0 : scalar, optional, default 1.5 - Only if ``algorithm = "nearest-neighbor"`` and ``method = "thinning"`. Cluster threshold. + Only if ``algorithm = "nearest-neighbor"`` and ``method = "thinning"``. Cluster threshold. M : int, optional, default 16 - Only if ``algorithm = "nearest-neighbor"`` and ``method = "thinning"`. Number of reshufflings. + Only if ``algorithm = "nearest-neighbor"`` and ``method = "thinning"``. Number of reshufflings. seed : int or None, optional, default None Only if ``algorithm = "nearest-neighbor"``. Seed for random number generator. rfact : int, optional, default 10 diff --git a/bruces/decluster/nearest_neighbor/_nearest_neighbor.py b/bruces/decluster/nearest_neighbor/_nearest_neighbor.py index 6e3d303..31fb312 100644 --- a/bruces/decluster/nearest_neighbor/_nearest_neighbor.py +++ b/bruces/decluster/nearest_neighbor/_nearest_neighbor.py @@ -42,11 +42,11 @@ def decluster( use_depth : bool, optional, default False If `True`, consider depth in interevent distance calculation. eta_0 : scalar or None, optional, default None - Only if ``method = "thinning"`. Initial cutoff threshold. If `None`, invoke :meth:`bruces.Catalog.fit_cutoff_threshold`. + Only if ``method = "thinning"``. Initial cutoff threshold. If `None`, invoke :meth:`bruces.Catalog.fit_cutoff_threshold`. alpha_0 : scalar, optional, default 1.5 - Only if ``method = "thinning"`. Cluster threshold. + Only if ``method = "thinning"``. Cluster threshold. M : int, optional, default 16 - Only if ``method = "thinning"`. Number of reshufflings. + Only if ``method = "thinning"``. Number of reshufflings. seed : int or None, optional, default None Seed for random number generator.