[Python-modules-commits] [python-social-auth] 62/322: Update GitHub documentation

[Wolfgang Borgert]

This is an automated email from the git hooks/post-receive script.

debacle pushed a commit to tag v0.2.10
in repository python-social-auth.

commit 6a5741e85ae0fc1041f1833ceb76f638f3a4f149
Author: Alex Muller <alex.muller at digital.cabinet-office.gov.uk>
Date:   Wed Dec 24 15:56:50 2014 +0000

    Update GitHub documentation
    
    - Capitalise GitHub consistently
    - Change App Id and Secret to reflect GitHub's naming
    - Use gender-neutral language when talking about people
---
 docs/backends/github.rst | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/docs/backends/github.rst b/docs/backends/github.rst
index 57a86bd..382c742 100644
--- a/docs/backends/github.rst
+++ b/docs/backends/github.rst
@@ -1,13 +1,13 @@
 GitHub
 ======
 
-Github works similar to Facebook (OAuth).
+GitHub works similar to Facebook (OAuth).
 
 - Register a new application at `GitHub Developers`_, set the callback URL to
   ``http://example.com/complete/github/`` replacing ``example.com`` with your
   domain.
 
-- Fill ``App Id`` and ``App Secret`` values in the settings::
+- Fill the ``Client ID`` and ``Client Secret`` values from GitHub in the settings::
 
       SOCIAL_AUTH_GITHUB_KEY = ''
       SOCIAL_AUTH_GITHUB_SECRET = ''
@@ -17,37 +17,37 @@ Github works similar to Facebook (OAuth).
       SOCIAL_AUTH_GITHUB_SCOPE = [...]
 
 
-Github for Organizations
+GitHub for Organizations
 ------------------------
 
 When defining authentication for organizations, use the
-``GithubOrganizationOAuth2`` backend instead. The settings are the same than
+``GithubOrganizationOAuth2`` backend instead. The settings are the same as
 the non-organization backend, but the names must be::
 
-    SOCIAL_AUTH_GITHUB_ORG_*
+      SOCIAL_AUTH_GITHUB_ORG_*
 
 Be sure to define the organization name using the setting::
 
       SOCIAL_AUTH_GITHUB_ORG_NAME = ''
 
 This name will be used to check that the user really belongs to the given
-organization and discard it in case he's not part of it.
+organization and discard it if they're not part of it.
 
 
-Github for Teams
+GitHub for Teams
 ----------------
 
-Similar to ``Github for Organizations``, there's a Github for Teams backend,
-use the backend ``GithubTeamOAuth2``. The settings are the same than
+Similar to ``GitHub for Organizations``, there's a GitHub for Teams backend,
+use the backend ``GithubTeamOAuth2``. The settings are the same as
 the basic backend, but the names must be::
 
     SOCIAL_AUTH_GITHUB_TEAM_*
 
-Be sure to define the ``Team Id`` using the setting::
+Be sure to define the ``Team ID`` using the setting::
 
       SOCIAL_AUTH_GITHUB_TEAM_ID = ''
 
 This ``id`` will be used to check that the user really belongs to the given
-team and discard it in case he's not part of it.
+team and discard it if they're not part of it.
 
 .. _GitHub Developers: https://github.com/settings/applications/new

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-social-auth.git