summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatt Riedemann <mriedem.os@gmail.com>2017-07-20 16:46:07 -0400
committerMatt Riedemann <mriedem.os@gmail.com>2017-07-20 16:50:59 -0400
commit72671fffe51898446c8671e122cd6ef11171fdb1 (patch)
tree85ffb1dfc9bec7f90e7e3ccf13365e68cd14f37f
parent52cc5c6cb3856dcddd455122742a5bf8de0fe834 (diff)
downloadpython-cinderclient-72671fffe51898446c8671e122cd6ef11171fdb1.tar.gz
Add release note for get_highest_client_server_version return type change3.0.0
Change Ica4d718b3de31c31da047f07c5154b242e122596 changed the return type on the cinderclient.client.get_highest_client_server_version method from a float to a str. Since it's a public API we should document the change with a release note. Change-Id: I197c80ef657156261ecbf51cee6300268438b639 Related-Bug: #1705093
-rw-r--r--releasenotes/notes/bug-1705093-9bc782d44018c27d.yaml10
1 files changed, 10 insertions, 0 deletions
diff --git a/releasenotes/notes/bug-1705093-9bc782d44018c27d.yaml b/releasenotes/notes/bug-1705093-9bc782d44018c27d.yaml
new file mode 100644
index 0000000..ee7ef73
--- /dev/null
+++ b/releasenotes/notes/bug-1705093-9bc782d44018c27d.yaml
@@ -0,0 +1,10 @@
+---
+fixes:
+ - |
+ Fixes `bug 1705093`_ by having the
+ ``cinderclient.client.get_highest_client_server_version`` method return a
+ string rather than a float. The problem with returning a float is when a
+ user of that method would cast the float result to a str which turns 3.40,
+ for example, into "3.4" which is wrong.
+
+ .. _bug 1705093: https://bugs.launchpad.net/python-cinderclient/+bug/1705093