comments for geometry building commands

这个提交包含在:
John Hartley
2019-08-24 12:22:20 +01:00
父节点 237af789f7
当前提交 0b4f26d1fe
共有 11 个文件被更改,包括 166 次插入11 次删除

查看文件

@@ -8,7 +8,17 @@ from tqdm import tqdm
class AddSurfaceWater(UserObjectGeometry):
"""User class for edge command."""
"""Allows you to add surface water to a :class:`FractalBox` in the model.
:param p1: The lower left (x,y,z) coordinates of a surface on a :class:`FractalBox`
:type p1: list, non-optional
:param p2: The lower left (x,y,z) coordinates of a surface on a :class:`FractalBox`
:type p2: list, non-optional
:param depth: Defines the depth of the water, which should be specified relative to the dimensions of the #fractal_box that the surface water is being applied.
:type depth: float, non-optional
:param fractal_box_id: An identifier for the :class:`FractalBox` that the water should be applied to
:type fractal_box_id: list, non-optional
"""
def __init__(self, **kwargs):
"""Constructor."""