Skip to content

Commit 2ba0d84

Browse files
committed
Docstring for DimDimPadding
1 parent 144f9b1 commit 2ba0d84

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/parcels/_core/utils/sgrid.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,13 @@ def to_attrs(self) -> dict[str, str | int]:
213213

214214
@dataclass
215215
class DimDimPadding:
216+
"""A data class representing a dimension-dimension-padding triplet for SGrid metadata.
217+
218+
This triplet can represent different relations depending on context within the standard
219+
Fr exampel - for "face_dimensions" this can show the relation between an edge (dim1) and a node
220+
(dim2).
221+
"""
222+
216223
dim1: str
217224
dim2: str
218225
padding: Padding

0 commit comments

Comments
 (0)