diff options
Diffstat (limited to 'docs/contributing.rst')
| -rw-r--r-- | docs/contributing.rst | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst index eed3866..5f05331 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -272,8 +272,12 @@ the autogenerated documentation read more cleanly: Consolidated example +.. code-block:: python + def foo(self, request, client, bar=None, key=None): """ + This method defines framework for `MAC Access Authentication`_ RFC. + This method checks the `key` against the `client`. The `request` is passed to maintain context. @@ -283,15 +287,18 @@ Consolidated example nonce="1336363200:dj83hs9s", mac="bhCQXTVyfj5cmA9uKkPFx1zeOXM=" - .. _`MAC Access Authentication`: https://tools.ietf.org/html/draft-ietf-oauth-v2-http-mac-01 - :param request: OAuthlib request. :type request: oauthlib.common.Request - :param client: Client object set by you, see ``.authenticate_client``. - :param bar: - :param key: MAC given provided by token endpoint. + :param client: User's defined Client object, see ``.authenticate_client``. + :param bar: Another example. + :param key: Another param. + :return: Explaination of return value and type + + .. _`MAC Access Authentication`: https://tools.ietf.org/html/draft-ietf-oauth-v2-http-mac-01 """ + + How pull requests are checked, tested, and done =============================================== |