You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently docstrings are in a variety of formats since I was testing out which could be rendered best by sphinx, to generate online documentation.
A todo item is to clean then up to apply consistent formatting. Now that we have the napoleon sphinx extension installed when generating docs, we can use Google-style docstrings. The older docstrings should be converted to a more legible style.
This is one of the recommended styles, per Google's style guide.
deffunc(arg1, arg2):
"""Summary line. Extended description of function. Args: arg1 (int): Description of arg1 arg2 (str): Description of arg2 Returns: bool: Description of return value """returnTrue
NumPy style
Another common & more legible style.
deffunc(arg1, arg2):
"""Summary line. Extended description of function. Parameters ---------- arg1 : int Description of arg1 arg2 : str Description of arg2 Returns ------- bool Description of return value """returnTrue
The text was updated successfully, but these errors were encountered:
Currently docstrings are in a variety of formats since I was testing out which could be rendered best by sphinx, to generate online documentation.
A todo item is to clean then up to apply consistent formatting. Now that we have the napoleon sphinx extension installed when generating docs, we can use Google-style docstrings. The older docstrings should be converted to a more legible style.
Style examples (from Napoleon's RTD site):
RST format
This is the "old" style, which we want to move away from.
Google style
This is one of the recommended styles, per Google's style guide.
NumPy style
Another common & more legible style.
The text was updated successfully, but these errors were encountered: