openstack/cinder
Code Issues Proposed changes

Merge "Minor fixes to microversion devref"

Browse Source
This commit is contained in:
Jenkins 2017-06-02 18:39:29 +00:00 committed by Gerrit Code Review
commit a0ab62b1e8
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/devref/api_microversion_dev.rst
View File

@ -199,7 +199,7 @@ default of ``3.1``) they would see the result from ``method_1``,
``3.4`` or later ``method_2``. ``3.4`` or later ``method_2``.
We could use ``wsgi.Controller.api_version`` decorator on the second We could use ``wsgi.Controller.api_version`` decorator on the second
``my_api_method`` as well, but then we would have to add ``# no qa`` to that ``my_api_method`` as well, but then we would have to add ``# noqa`` to that
line to avoid failing flake8's ``F811`` rule. So the recommended approach is line to avoid failing flake8's ``F811`` rule. So the recommended approach is
to use the ``api_version`` decorator from the first method that is defined, as to use the ``api_version`` decorator from the first method that is defined, as
illustrated by the example above, and then use ``my_api_method`` decorator for illustrated by the example above, and then use ``my_api_method`` decorator for
@ -214,11 +214,11 @@ A method with only small changes between versions
A method may have only small changes between microversions, in which A method may have only small changes between microversions, in which
case you can decorate a private method:: case you can decorate a private method::
@api_version("3.1", "3.4") @wsgi.Controller.api_version("3.1", "3.4")
def _version_specific_func(self, req, arg1): def _version_specific_func(self, req, arg1):
pass pass
@api_version(min_ver="3.5") # noqa @_version_specific_func.api_version(min_ver="3.5")
def _version_specific_func(self, req, arg1): def _version_specific_func(self, req, arg1):
pass pass