Skip to content

Commit 7f3f996

Browse files
committed
Updated calculate_covariance() docstring
1 parent a4cc2a4 commit 7f3f996

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

CHANGELOG.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Changes - from version >= 1.x
5151
* [docs] docstring example for `Deviation`
5252
* [docs] docstring examples for `AggregatedVariogram` and `regularize()`
5353
* [docs] docstring examples for `ExperimentalVariogram` and `build_experimental_variogram()`, `calculate_semivariance()`, used parameters `values` and `geometries`
54-
* [docs]
54+
* [docs] docstring examples for `calculate_covariance()`, used parameters `values` and `geometries`
5555

5656
2025-10-11
5757
----------

src/pyinterpolate/semivariogram/experimental/experimental_covariogram.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,10 @@ def calculate_covariance(ds: Union[ArrayLike, VariogramPoints] = None,
136136
>>> STEP_SIZE = 1
137137
>>> MAX_RANGE = 4
138138
>>> covariances = calculate_covariance(
139-
... REFERENCE_INPUT, STEP_SIZE, MAX_RANGE
139+
... values=REFERENCE_INPUT[:, -1],
140+
... geometries=REFERENCE_INPUT[:, :-1],
141+
... step_size=STEP_SIZE,
142+
... max_range=MAX_RANGE
140143
... )
141144
>>> print(covariances[0][0])
142145
[ 1. -0.54340278 24. ]

0 commit comments

Comments
 (0)