Make two-factor auth consistent with GitHub docs

tedmiston · tedmiston · commit 4a14067a32d3 · 2018-07-28T15:22:26.000-04:00
Example - https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/
diff --git a/docs/source/examples/two_factor_auth.rst b/docs/source/examples/two_factor_auth.rst
@@ -1,11 +1,11 @@
-Using Two Factor Authentication with github3.py
+Using Two-factor Authentication with github3.py
 ===============================================
 
-GitHub recently added support for Two Factor Authentication to ``github.com``
+GitHub recently added support for Two-factor Authentication to ``github.com``
 and shortly thereafter added support for it on ``api.github.com``. In version
 0.8, github3.py also added support for it and you can use it right now.
 
-To use Two Factor Authentication, you must define your own function that will
+To use Two-factor Authentication, you must define your own function that will
 return your one time authentication code. You then provide that function when
 logging in with github3.py.
 
@@ -33,5 +33,5 @@ For example:
     g = github3.login('sigmavirus24', 'my_password',
                       two_factor_callback=my_two_factor_function)
 
-Then each time the API tells github3.py it requires a Two Factor Authentication
+Then each time the API tells github3.py it requires a Two-factor Authentication
 code, github3.py will call ``my_two_factor_function`` which prompt you for it.
diff --git a/docs/source/release-notes/0.8.1.rst b/docs/source/release-notes/0.8.1.rst
@@ -1,6 +1,6 @@
 0.8.1: 2014-01-26
 -----------------
 
-- Add documentation for using Two Factor Authentication
+- Add documentation for using Two-factor Authentication
 
 - Fix oversight where ``github3.login`` could not be used for 2FA
diff --git a/src/github3/api.py b/src/github3/api.py
@@ -72,7 +72,7 @@ def login(username=None, password=None, token=None, two_factor_callback=None):
     :param str password: password for the login
     :param str token: OAuth token
     :param func two_factor_callback: (optional), function you implement to
-        provide the Two Factor Authentication code to GitHub when necessary
+        provide the Two-factor Authentication code to GitHub when necessary
     :returns: :class:`GitHub <github3.github.GitHub>`
 
     """
@@ -100,7 +100,7 @@ def enterprise_login(username=None, password=None, token=None, url=None,
     :param str token: OAuth token
     :param str url: URL of a GitHub Enterprise instance
     :param func two_factor_callback: (optional), function you implement to
-        provide the Two Factor Authentication code to GitHub when necessary
+        provide the Two-factor Authentication code to GitHub when necessary
     :returns: :class:`GitHubEnterprise <github3.github.GitHubEnterprise>`
 
     """
diff --git a/src/github3/github.py b/src/github3/github.py
@@ -953,7 +953,7 @@ def login(self, username=None, password=None, token=None,
         :param str token:
             OAuth token
         :param func two_factor_callback:
-            (optional), function you implement to provide the Two Factor
+            (optional), function you implement to provide the Two-factor
             Authentication code to GitHub when necessary
         """
         if username and password:
