[ckan-changes] [okfn/ckan] 6c274d: [#943] Add custom docstrings for some 3rd-party st...

Thu Aug 29 15:05:07 UTC 2013

  Branch: refs/heads/943-writing-extensions-tutorial
  Home:   https://github.com/okfn/ckan
  Commit: 6c274d35b3b43d9b96842ec6a16e6e10b8a5285a
      https://github.com/okfn/ckan/commit/6c274d35b3b43d9b96842ec6a16e6e10b8a5285a
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-08-29 (Thu, 29 Aug 2013)

  Changed paths:
    M ckan/plugins/toolkit.py
    M ckan/plugins/toolkit_sphinx_extension.py

  Log Message:
  -----------
  [#943] Add custom docstrings for some 3rd-party stuff

The plugins toolkit imports some things from 3rd-party libraries, e.g.
the request, response and c objects from Pylons. We want to use our own
docstrings for these rather than having the 3rd-party docstrings appear
in the CKAN docs. Also in some cases the 3rd-psrty function has no
docstring, or introspection would end up with a class docstring where
what we actually want is to document a specific object-instance.

So add custom docstring overrides as a feature implemented in toolkit.py
and toolkit_sphinx_extension.py.