diff options
| author | Brant Knudson <bknudson@us.ibm.com> | 2015-07-26 10:00:01 -0500 |
|---|---|---|
| committer | Brant Knudson <bknudson@us.ibm.com> | 2015-08-29 11:28:01 -0500 |
| commit | e76423f7839aec20616849b8796287690562fe21 (patch) | |
| tree | aba2a49c28065d2afa3474efbb9eb83b62cf95d6 /keystoneclient/httpclient.py | |
| parent | 42bd016e1f0e011ba745dba243e62401298e324c (diff) | |
| download | python-keystoneclient-e76423f7839aec20616849b8796287690562fe21.tar.gz | |
Proper deprecation for httpclient.USER_AGENT
httpclient's USER_AGENT constant wasn't properly deprecated since
the deprecation was only a comment. Proper deprecation requires use
of warnings/debtcollector and documentation, but since this is a
module symbol there's no way to put out a warning, so it's just
documentation in this case.
bp deprecations
Change-Id: I02c77c690a31eea40935d2756748382abec86867
Diffstat (limited to 'keystoneclient/httpclient.py')
| -rw-r--r-- | keystoneclient/httpclient.py | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/keystoneclient/httpclient.py b/keystoneclient/httpclient.py index b15db24..cb910b6 100644 --- a/keystoneclient/httpclient.py +++ b/keystoneclient/httpclient.py @@ -67,9 +67,13 @@ from keystoneclient import utils _logger = logging.getLogger(__name__) -# This variable is moved and using it via httpclient is deprecated. -# Maintain here for compatibility. USER_AGENT = client_session.USER_AGENT +"""Default user agent string. + +This property is deprecated as of the 1.7.0 release in favor of +:data:`keystoneclient.session.USER_AGENT` and may be removed in the 2.0.0 +release. +""" @removals.remove(message='Use keystoneclient.session.request instead.', |