Developer’s guide¶
Writing a docstring¶
pysmurf docstrings should be written in the NumPy style, and documentation should be written in the reStructuredText (reST) language. See the pandas docstring guide and the numpydoc docstring guide for a great introduction to both the NumPy docstring style and reST markup, as well as many examples.