Skip to content

Commit 2a154d6

Browse files
committed
add docstring
1 parent 348d094 commit 2a154d6

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

geoapps_utils/modelling/plates.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,11 @@ def __init__(self, params: PlateModel):
106106

107107
@classmethod
108108
def from_maxwell_plate(cls, plate: MaxwellPlate) -> Self:
109-
"""Construct a Plate from geoh5py MaxwellPlate object."""
109+
"""
110+
Construct a Plate from geoh5py MaxwellPlate object.
111+
112+
:param plate: Maxwell plate object to construct the Plate from.
113+
"""
110114
if plate.geometry is None:
111115
raise ValueError("Maxwell plate must have its geometry set.")
112116
return cls(PlateModel.from_maxwell_plate_geometry(plate.geometry))

0 commit comments

Comments
 (0)