From 2f44b2e89c00135d832f8d00fd9b1b74f8977a1a Mon Sep 17 00:00:00 2001 From: Vincent Rose Date: Fri, 22 Dec 2023 07:36:24 -0700 Subject: [PATCH] Update the class name for NetrcAuth in the examples (#2860) --- doc/changes.rst | 6 +++--- doc/examples/Authentication.rst | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/changes.rst b/doc/changes.rst index 987f0c82b9..4f4f91afb2 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -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' @@ -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) diff --git a/doc/examples/Authentication.rst b/doc/examples/Authentication.rst index 60697221ba..1e22e32de7 100644 --- a/doc/examples/Authentication.rst +++ b/doc/examples/Authentication.rst @@ -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'