Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation: provide formatted docstrings for all functions #15

Open
msyriac opened this issue Sep 17, 2018 · 1 comment
Open
Labels
documentation help wanted Extra attention is needed

Comments

@msyriac
Copy link
Member

msyriac commented Sep 17, 2018

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
@msyriac msyriac added the help wanted Extra attention is needed label Sep 17, 2018
@xzackli xzackli self-assigned this Sep 28, 2018
@mhasself
Copy link
Member

mhasself commented Oct 8, 2018

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 msyriac changed the title Add documentation Add documentation: provide formatted docstrings for all functions May 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants