Skip to content

Commit

Permalink
Update the class name for NetrcAuth in the examples (#2860)
Browse files Browse the repository at this point in the history
  • Loading branch information
vinnybod committed Dec 22, 2023
1 parent 9c61a2a commit 2f44b2e
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions doc/changes.rst
Expand Up @@ -69,11 +69,11 @@ Add a timezone information to your ``datetime`` instances before comparison:

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

.. code-block:: python
>>> auth = Auth.Netrc()
>>> auth = Auth.NetrcAuth()
>>> g = Github(auth=auth)
>>> g.get_user().login
'login'
Expand Down Expand Up @@ -110,7 +110,7 @@ Improvements
* Add ``license`` attribute to ``Repository`` (#2721) (26d353e7)
* Add missing attributes to ``Repository`` (#2742) (65cfeb1b)
* Add ``is_alphanumeric`` attribute to ``Autolink`` and ``Repository.create_autolink`` (#2630) (b6a28a26)
* Suppress ``requests`` fallback to netrc, provide ``github.Auth.Netrc`` (#2739) (ac36f6a9)
* Suppress ``requests`` fallback to netrc, provide ``github.Auth.NetrcAuth`` (#2739) (ac36f6a9)
* Pass Requester arguments to ``AppInstallationAuth.__integration`` (#2695) (8bf542ae)
* Adding feature for enterprise consumed license (#2626) (a7bfdf2d)
* Search Workflows by Name (#2711) (eadc241e)
Expand Down
4 changes: 2 additions & 2 deletions doc/examples/Authentication.rst
Expand Up @@ -47,11 +47,11 @@ Write your credentials into a ``.netrc`` file:
You might need to create the environment variable ``NETRC`` with the path to this file.

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

.. code-block:: python
>>> auth = Auth.Netrc()
>>> auth = Auth.NetrcAuth()
>>> g = Github(auth=auth)
>>> g.get_user().login
'login'
Expand Down

0 comments on commit 2f44b2e

Please sign in to comment.