Skip to content

Commit ef83bd5

Browse files
committed
Documentation updates
1 parent 0bb1a33 commit ef83bd5

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

src/LandSea.jl

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,10 @@ export
1919
Abstract supertype for LandSea Datasets. All `LandSeaData` types contain the following fields:
2020
* `lon` - Vector containing the longitude points for the Land-Sea Dataset
2121
* `lat` - Vector containing the latitude points for the Land-Sea Dataset
22-
* `lsm` - Array containing data regarding the Land-Sea Mask. 1 is Land, 0 is Ocean, NaN is outside the bounds of the GeoRegion
22+
* `lsm` - Vector or Array containing data regarding the Land-Sea Mask. 1 is Land, 0 is Ocean, NaN is outside the bounds of the GeoRegion
23+
24+
!!! info
25+
If `lsm` is a vector, then `lon`, `lat` and `lsm` all must have the same length
2326
"""
2427
abstract type LandSeaData end
2528

@@ -29,7 +32,10 @@ abstract type LandSeaData end
2932
A LandSea Dataset that also contains information on the topographic height.
3033
3134
A `LandSeaTopo` type will also contain the following field:
32-
* `z` - Array containing data regarding the Orographic Height in meters. NaN is outside the bounds of the GeoRegion
35+
* `z` - Vector or Array containing data regarding the Orographic Height in meters. NaN is outside the bounds of the GeoRegion
36+
37+
!!! info
38+
If `z` or `lsm` are vectors, then `lon`, `lat`, `lsm` and `z` all must be vectors of the same length
3339
"""
3440
struct LandSeaTopo{FT1<:Real,FT2<:Real} <: LandSeaData
3541

0 commit comments

Comments
 (0)