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
There are two ways you can contribute to documentation.
Usage guide
Open docs/usage.rst and start describing how you would carry out commonly done map manipulation tasks. A skeleton structure already exists.
Docstrings
Dig into each module and either edit existing function docstrings or add to empty ones. Try to adapt the docstrings to conform to ReStructured Text (RST) format. Try to add examples that can be understood by doctest.
You can preview docs on your computer before pushing to the repo by doing
cd docs
make html
firefox _build/html/index.html
The text was updated successfully, but these errors were encountered:
Please note that the current "Developer's Guide" recommends "Google" format for docstrings. This is based on the desire that the docstrings render nicely in all of:
python's built-in "help()"
the raw source code text
on sphinx / readthedocs
msyriac
changed the title
Add documentation
Add documentation: provide formatted docstrings for all functions
May 8, 2020
There are two ways you can contribute to documentation.
Usage guide
Open
docs/usage.rst
and start describing how you would carry out commonly done map manipulation tasks. A skeleton structure already exists.Docstrings
Dig into each module and either edit existing function docstrings or add to empty ones. Try to adapt the docstrings to conform to ReStructured Text (RST) format. Try to add examples that can be understood by
doctest
.You can preview docs on your computer before pushing to the repo by doing
The text was updated successfully, but these errors were encountered: