From e8c7946a23e2d58939b0c4c6914a314437134e7a Mon Sep 17 00:00:00 2001 From: Gorka Eguileor Date: Fri, 2 Jun 2017 10:38:25 +0200 Subject: [PATCH] Minor fixes to microversion devref This patch fixes 3 minor issues in the microversion devref: - ``# no qa`` is replaced with ``# noqa`` - Change example usage of api_version requiring noqa with preferred method that doesn't. - Replace api_version decorator in example with the full and correct decorator wsgi.Controller.api_version. TrivialFix Change-Id: I31af4c566683cf5b38b74c9f9164fdc6aa0ee6c7 --- doc/source/devref/api_microversion_dev.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/source/devref/api_microversion_dev.rst b/doc/source/devref/api_microversion_dev.rst index 30e814704c8..a79c29c9fdc 100644 --- a/doc/source/devref/api_microversion_dev.rst +++ b/doc/source/devref/api_microversion_dev.rst @@ -199,7 +199,7 @@ default of ``3.1``) they would see the result from ``method_1``, ``3.4`` or later ``method_2``. 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 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 @@ -214,11 +214,11 @@ 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("3.1", "3.4") + @wsgi.Controller.api_version("3.1", "3.4") def _version_specific_func(self, req, arg1): pass - @api_version(min_ver="3.5") # noqa + @_version_specific_func.api_version(min_ver="3.5") def _version_specific_func(self, req, arg1): pass