Skip to content

Commit 2f44b2e

Browse files
authored
Update the class name for NetrcAuth in the examples (#2860)
1 parent 9c61a2a commit 2f44b2e

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

doc/changes.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,11 @@ Add a timezone information to your ``datetime`` instances before comparison:
6969

7070
A Netrc file (e.g. ``~/.netrc``) does not override PyGithub authentication, anymore.
7171
If you require authentication through Netrc, then this is a breaking change.
72-
Use a ``github.Auth.Netrc`` instance to use Netrc credentials:
72+
Use a ``github.Auth.NetrcAuth`` instance to use Netrc credentials:
7373

7474
.. code-block:: python
7575
76-
>>> auth = Auth.Netrc()
76+
>>> auth = Auth.NetrcAuth()
7777
>>> g = Github(auth=auth)
7878
>>> g.get_user().login
7979
'login'
@@ -110,7 +110,7 @@ Improvements
110110
* Add ``license`` attribute to ``Repository`` (#2721) (26d353e7)
111111
* Add missing attributes to ``Repository`` (#2742) (65cfeb1b)
112112
* Add ``is_alphanumeric`` attribute to ``Autolink`` and ``Repository.create_autolink`` (#2630) (b6a28a26)
113-
* Suppress ``requests`` fallback to netrc, provide ``github.Auth.Netrc`` (#2739) (ac36f6a9)
113+
* Suppress ``requests`` fallback to netrc, provide ``github.Auth.NetrcAuth`` (#2739) (ac36f6a9)
114114
* Pass Requester arguments to ``AppInstallationAuth.__integration`` (#2695) (8bf542ae)
115115
* Adding feature for enterprise consumed license (#2626) (a7bfdf2d)
116116
* Search Workflows by Name (#2711) (eadc241e)

doc/examples/Authentication.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,11 @@ Write your credentials into a ``.netrc`` file:
4747
4848
You might need to create the environment variable ``NETRC`` with the path to this file.
4949

50-
Then, use a ``github.Auth.Netrc`` instance to access these information:
50+
Then, use a ``github.Auth.NetrcAuth`` instance to access these information:
5151

5252
.. code-block:: python
5353
54-
>>> auth = Auth.Netrc()
54+
>>> auth = Auth.NetrcAuth()
5555
>>> g = Github(auth=auth)
5656
>>> g.get_user().login
5757
'login'

0 commit comments

Comments
 (0)