Add release note for get_highest_client_server_version return type change

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
This commit is contained in:
Matt Riedemann 2017-07-20 16:46:07 -04:00
parent 52cc5c6cb3
commit 72671fffe5
1 changed files with 10 additions and 0 deletions

View File

@ -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