Skip to content

Commit 042b7e5

Browse files
committed
Add docstrings
1 parent d6d6277 commit 042b7e5

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

parcels/gridadapter.py

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,12 @@ def __init__(self, grid: xgcm.Grid, mesh="flat"):
4646

4747
@property
4848
def lon(self):
49+
"""
50+
Note
51+
----
52+
Included for compatibility with v3 codebase. May be removed in future.
53+
TODO v4: Evaluate
54+
"""
4955
try:
5056
_ = self.grid.axes["X"]
5157
except KeyError:
@@ -54,6 +60,12 @@ def lon(self):
5460

5561
@property
5662
def lat(self):
63+
"""
64+
Note
65+
----
66+
Included for compatibility with v3 codebase. May be removed in future.
67+
TODO v4: Evaluate
68+
"""
5769
try:
5870
_ = self.grid.axes["Y"]
5971
except KeyError:
@@ -62,6 +74,12 @@ def lat(self):
6274

6375
@property
6476
def depth(self):
77+
"""
78+
Note
79+
----
80+
Included for compatibility with v3 codebase. May be removed in future.
81+
TODO v4: Evaluate
82+
"""
6583
try:
6684
_ = self.grid.axes["Z"]
6785
except KeyError:
@@ -98,10 +116,22 @@ def tdim(self):
98116

99117
@property
100118
def time_origin(self):
119+
"""
120+
Note
121+
----
122+
Included for compatibility with v3 codebase. May be removed in future.
123+
TODO v4: Evaluate
124+
"""
101125
return TimeConverter(self._datetimes[0])
102126

103127
@property
104128
def _z4d(self) -> Literal[0, 1]:
129+
"""
130+
Note
131+
----
132+
Included for compatibility with v3 codebase. May be removed in future.
133+
TODO v4: Evaluate
134+
"""
105135
return 1 if self.depth.shape == 4 else 0
106136

107137
@property

0 commit comments

Comments
 (0)