From caed9b1bb19742eec9e70f25fc690407488d27df Mon Sep 17 00:00:00 2001 From: hellerve Date: Thu, 22 Oct 2015 16:25:11 +0200 Subject: [PATCH 1/3] added note to the real world example explaining its caveats --- docs/examples/real_world_example.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/examples/real_world_example.rst b/docs/examples/real_world_example.rst index e85a94ab..cc29b89a 100644 --- a/docs/examples/real_world_example.rst +++ b/docs/examples/real_world_example.rst @@ -8,6 +8,12 @@ a web application might look like using the `Flask web framework `_ and GitHub as a provider. It should be easily transferrable to any web framework. +.. note + While the flow remains the same across msot providers, Github is special in that + the `redirect_uri` parameter is optional. This means that it may be necessary to + explicitly pass a redirect_uri to the `OAuth2Session` object (e.g. when creating + a custom OAuthProvider with `flask-oauthlib`). + .. code-block:: python from requests_oauthlib import OAuth2Session From d6bde7d1b3d694f25acffd03e379edd37ba99dfb Mon Sep 17 00:00:00 2001 From: hellerve Date: Thu, 22 Oct 2015 16:26:31 +0200 Subject: [PATCH 2/3] rst syntax fix --- docs/examples/real_world_example.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/examples/real_world_example.rst b/docs/examples/real_world_example.rst index cc29b89a..648686f3 100644 --- a/docs/examples/real_world_example.rst +++ b/docs/examples/real_world_example.rst @@ -8,7 +8,7 @@ a web application might look like using the `Flask web framework `_ and GitHub as a provider. It should be easily transferrable to any web framework. -.. note +.. note:: While the flow remains the same across msot providers, Github is special in that the `redirect_uri` parameter is optional. This means that it may be necessary to explicitly pass a redirect_uri to the `OAuth2Session` object (e.g. when creating From 1849a3130adbe2ef498195c3fa80b8e793f57080 Mon Sep 17 00:00:00 2001 From: hellerve Date: Thu, 22 Oct 2015 16:57:20 +0200 Subject: [PATCH 3/3] fixed the layout of the note --- docs/examples/real_world_example.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/examples/real_world_example.rst b/docs/examples/real_world_example.rst index 648686f3..86a542e3 100644 --- a/docs/examples/real_world_example.rst +++ b/docs/examples/real_world_example.rst @@ -8,11 +8,10 @@ a web application might look like using the `Flask web framework `_ and GitHub as a provider. It should be easily transferrable to any web framework. -.. note:: - While the flow remains the same across msot providers, Github is special in that - the `redirect_uri` parameter is optional. This means that it may be necessary to - explicitly pass a redirect_uri to the `OAuth2Session` object (e.g. when creating - a custom OAuthProvider with `flask-oauthlib`). +.. note:: While the flow remains the same across moat providers, Github is special in that + the ``redirect_uri`` parameter is optional. This means that it may be necessary to + explicitly pass a redirect_uri to the ``OAuth2Session`` object (e.g. when creating + a custom OAuthProvider with ``flask-oauthlib``). .. code-block:: python