diff options
author | Patrick Totzke <patricktotzke@gmail.com> | 2012-08-10 13:27:46 +0100 |
---|---|---|
committer | Patrick Totzke <patricktotzke@gmail.com> | 2012-08-10 13:27:46 +0100 |
commit | 80354cbcff7a8150c6d58728c7636f295bc94316 (patch) | |
tree | d90eecec6e3706cadaa7c858827de1cd3901f2ca /docs/source/api | |
parent | 74bf8409765c1c3a415c4850c397fc8d3936b957 (diff) |
docs: update some links
Diffstat (limited to 'docs/source/api')
-rw-r--r-- | docs/source/api/contributing.rst | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/source/api/contributing.rst b/docs/source/api/contributing.rst index ff184484..a288a7f8 100644 --- a/docs/source/api/contributing.rst +++ b/docs/source/api/contributing.rst @@ -8,15 +8,16 @@ You can send patches to notmuch's mailing list but pull requests on github are p Here are a few more things you should know and check before you send pull requests: * Follow :pep:`8`. This means in particular a maximum linewidth of *79* and no trailing - white spaces. If in doubt, use an `automatic tool <http://pypi.python.org/pypi/pep8>`_ + white spaces. If in doubt, use an Automatic tool + (`[0] <http://www.logilab.org/857>`_, `[1] <http://pypi.python.org/pypi/pep8/>`_, `[2] + <http://pypi.python.org/pypi/pyflakes/>`_) to verify your code. * Document! Needless to say, we want readable and well documented code. Moreover, - * use `sphinx directives <http://sphinx.pocoo.org/rest.html>`_ to document + * use `sphinx directives <http://sphinx.pocoo.org/domains.html#info-field-lists>`_ to document the parameters and return values of your methods so that we maintain up-to-date API docs. * Make sure your patch doesn't break the API docs. The build service at `readthedocs.org <http://alot.rtfd.org>`_ is fragile when it comes to new import statements in our code. * If you implemented a new feature, update the user manual in :file:`/docs/user` accordingly. - |