adjusted warning message

Author: michaelthomasletts

boto3_refresh_session/session.py

@@ -6,15 +6,11 @@
 
 .. warning::
     ``AutoRefreshableSession`` was not tested for manually passing hard-coded
-    account credentials to the :class:`boto3.session.Session` or ``boto3.client`` 
-    objects! There are optional ``session_kwargs`` and ``client_kwargs``
-    parameters available for passing hard-coded account credentials, which
-    should work; however, that cannot be guaranteed! In any case, the ``boto3``
-    documentation generally recommends against passing hard-coded account credentials
-    as parameters; it is for that reason the documentation below, and everywhere
-    else, only mentions ``~/.aws/config`` and ``~/.aws/credentials`` for 
-    authorization. Since the ``session_kwargs`` and ``client_kwargs`` parameters 
-    were not tested, you will need to use those parameters at your own discretion.
+    account credentials to the ``boto3.client`` object! There is an optional 
+    ``client_kwargs`` parameter available for doing so, which *should* work; 
+    however, that cannot be guaranteed as that functionality was not tested.
+    Pass hard-coded credentials with the ``client_kwargs`` parameter at your
+    own discretion.
 """
 __all__ = ["AutoRefreshableSession"]
 

doc/authorization.rst

@@ -5,15 +5,11 @@ Authorization
 
 .. warning::
     ``AutoRefreshableSession`` was not tested for manually passing hard-coded
-    account credentials to the :class:`boto3.session.Session` or ``boto3.client`` 
-    objects! There are optional ``session_kwargs`` and ``client_kwargs``
-    parameters available for passing hard-coded account credentials, which
-    *should* work; however, that cannot be guaranteed! In any case, the ``boto3``
-    documentation generally recommends against passing hard-coded account credentials
-    as parameters; it is for that reason the documentation below, and everywhere
-    else, only mentions ``~/.aws/config`` and ``~/.aws/credentials`` for 
-    authorization. Since the ``session_kwargs`` and ``client_kwargs`` parameters 
-    were not tested, you will need to use those parameters at your own discretion.
+    account credentials to the ``boto3.client`` object! There is an optional 
+    ``client_kwargs`` parameter available for doing so, which *should* work; 
+    however, that cannot be guaranteed as that functionality was not tested.
+    Pass hard-coded credentials with the ``client_kwargs`` parameter at your
+    own discretion.
 
 In order to use this package, it is **recommended** that you follow one of the
 below methods for authorizing access to your AWS instance:

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "boto3-refresh-session"
-version = "0.0.26"
+version = "0.0.27"
 description = "A simple Python package for refreshing boto3 sessions automatically."
 authors = [
     {name = "Mike Letts",email = "[email protected]"}