openstack/nova
Code Issues Proposed changes

devref:Don't suggest decorate private method

Browse Source 
per https://review.openstack.org/#/c/164229
suggested on the spec, we should not suggest private method
decoration on microversion, so this update the doc to sync it

Change-Id: Ie937173a4d1542eb1c551795ca371ebce69c7078
This commit is contained in:
jichenjc 2015-10-06 09:34:11 +08:00
parent 4474dce9e6
commit a6559b6857
1 changed files with 0 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/source/api_microversion_dev.rst
View File

@ -234,25 +234,6 @@ them will need ``# noqa`` to avoid failing flake8's ``F811`` rule. The
two methods may be different in any kind of semantics (schema two methods may be different in any kind of semantics (schema
validation, return values, response codes, etc) validation, return values, response codes, etc)
A method with only small changes between versions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A method may have only small changes between microversions, in which
case you can decorate a private method::
@api_version("2.1", "2.4")
def _version_specific_func(self, req, arg1):
pass
@api_version(min_version="2.5") # noqa
def _version_specific_func(self, req, arg1):
pass
def show(self, req, id):
.... common stuff ....
self._version_specific_func(req, "foo")
.... common stuff ....
A change in schema only A change in schema only
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~