Update documentation for v0.9.0

prkumar · May 13, 2019 · adbb8ee · adbb8ee
1 parent 2c9e174
commit adbb8ee
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 5 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -294,6 +294,7 @@ Added
 .. _`Semantic Versioning`: https://packaging.python.org/tutorials/distributing-packages/#semantic-versioning-preferred
 
 .. Releases
+.. _0.9.0: https://github.com/prkumar/uplink/compare/v0.8.0...v0.9.0
 .. _0.8.0: https://github.com/prkumar/uplink/compare/v0.7.0...v0.8.0
 .. _0.7.0: https://github.com/prkumar/uplink/compare/v0.6.1...v0.7.0
 .. _0.6.1: https://github.com/prkumar/uplink/compare/v0.6.0...v0.6.1

diff --git a/docs/source/user/auth.rst b/docs/source/user/auth.rst
@@ -82,14 +82,17 @@ sent as part of every request.
 
     from uplink.auth import ApiTokenParam, ApiTokenHeader, BearerToken
 
-    # Passing a random auth query parameter
-    github = GitHub(BASE_URL, auth=ApiTokenParam("access_token", access_token))
+    # Passing an auth token as a query parameter
+    token_auth = ApiTokenParam("access_token", access_token)
+    github = GitHub(BASE_URL, auth=token_auth)
 
-    # Passing a random auth header
-    github = GitHub(BASE_URL, auth=ApiTokenHeader("Access-Token", access_token))
+    # Passing the token as a header value
+    token_auth = ApiTokenHeader("Access-Token", access_token)
+    github = GitHub(BASE_URL, auth=token_auth)
 
     # Passing a Bearer auth token
-    github = GitHub(BASE_URL, auth=BearerToken(access_token))
+    bearer_auth = BearerToken(access_token)
+    github = GitHub(BASE_URL, auth=bearer_auth)
 
 Using Auth Support for Requests and aiohttp
 -------------------------------------------