Skip to content

Commit

Permalink
fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
keurfonluu committed Dec 14, 2022
1 parent 686e9ee commit fc22e9a
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
8 changes: 4 additions & 4 deletions bruces/_catalog.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions bruces/decluster/_helpers.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions bruces/decluster/nearest_neighbor/_nearest_neighbor.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit fc22e9a

Please sign in to comment.