Skip to content

Commit a61f0bf

Browse files
committed
Adjust notes in docstrings to common format
1 parent f775b18 commit a61f0bf

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

src/krig/simple.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Simple Kriging with geostatistical function `fun` and constant `mean`.
99
1010
### Notes
1111
12-
* Simple Kriging requires stationary geostatistical function
12+
Simple Kriging requires stationary geostatistical function.
1313
"""
1414
struct SimpleKriging{F<:GeoStatsFunction,M<:AbstractVector} <: KrigingModel
1515
# input fields

src/krig/universal.jl

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,11 @@ for `dim` geospatial coordinates.
1515
1616
### Notes
1717
18-
* Drift functions should be smooth for numerical stability
19-
* Include a constant drift (e.g. `p -> 1`) for unbiased estimation
20-
* [`OrdinaryKriging`](@ref) is recovered with `drifts = [p -> 1]`
18+
Drift functions should be smooth for numerical stability.
19+
20+
Include a constant drift (e.g. `p -> 1`) for unbiased estimation.
21+
22+
[`OrdinaryKriging`](@ref) is recovered with `drifts = [p -> 1]`.
2123
"""
2224
struct UniversalKriging{F<:GeoStatsFunction,D} <: KrigingModel
2325
fun::F

0 commit comments

Comments
 (0)