]> git.ipfire.org Git - thirdparty/patchwork.git/commit
views/xmlrpc: Add documentation for API methods
authorStephen Finucane <stephen.finucane@intel.com>
Mon, 12 Oct 2015 16:20:10 +0000 (11:20 -0500)
committerStephen Finucane <stephen.finucane@intel.com>
Mon, 26 Oct 2015 21:03:16 +0000 (21:03 +0000)
commit0f37046b74f539b5a485de317bfa04843b47f194
tree8186848a4f5f5e611d47d6ced6db4af49905442b
parent63f42544f5bbe3d45d63d1d0f102cf9b53cf3054
views/xmlrpc: Add documentation for API methods

This will be useful for populating the XML-RPC API documentation.

Note that this uses the Google-style docstring format. This format is
easier to read than the information-dense, "classic" Sphinx docstring
format making it more suitable for use with pydoc (which does not do
any post-processing and it used by the 'DocXMLRPCServer' module). If
generating documentation using Sphinx, this will require the usage of
the 'sphinx.ext.napoleon' extension.

Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
patchwork/views/xmlrpc.py