Setter/getter documentation
Finish the setter/getter documentation for each of the classes. Follow the Napoleon docs Google style Python docstrings example for the readwrite_property() property method on that webpage, copied below.
Class checklist:
-
RiverGrid -
Particles -
FallingParticles -
LarvalParticles
Google style example:
@property
def readwrite_property(self):
"""list(str): Properties with both a getter and setter
should only be documented in their getter method.
If the setter method contains notable behavior, it should be
mentioned here.
"""
return ['readwrite_property']
@readwrite_property.setter
def readwrite_property(self, value):
value
Also update the docstrings of:
-
Settings.py -
Helper.py
Edited by Alexander Prescott