[PATCH v3] views/xmlrpc: Add documentation for API methods

Finucane, Stephen stephen.finucane at intel.com
Tue Oct 27 08:06:47 AEDT 2015


> 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 at intel.com>
> --
> v2:
> - Replace some Sphinx-style parameter documentation with Google-style
> - Add missing parameter for 'patch_set' method

Merged.


More information about the Patchwork mailing list