openstack/os-vif
Code Issues Proposed changes

Fix docstrings to work with Sphinx 1.7.4

Browse Source 
According to the thread at
http://lists.openstack.org/pipermail/openstack-dev/2018-May/130581.html
some projects including networking-midonet can not build docs with
sphinx 1.7.4+  This seems to be becaus the parser is now more strict?

This patch *seems* to fix those doc builds

Change-Id: Ie96dca126e727fc9a34eece1590a92f7dd3af426
Partial-Bug: 1771092
This commit is contained in:
Tony Breeds 2018-06-21 13:11:46 +10:00 committed by YAMAMOTO Takashi
parent d08b147ea4
commit 4e1e6de6d4
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
os_vif/plugin.py
View File

@ -51,7 +51,7 @@ class PluginBase(object):
:param vif: `os_vif.objects.vif.VIFBase` object.
:param instance_info: `os_vif.objects.instance_info.InstanceInfo`
object.
:raises `processutils.ProcessExecutionError`. Plugins implementing
:raises: `processutils.ProcessExecutionError`. Plugins implementing
this method should let `processutils.ProcessExecutionError`
bubble up.
"""
@ -64,7 +64,7 @@ class PluginBase(object):
:param vif: `os_vif.objects.vif.VIFBase` object.
:param instance_info: `os_vif.objects.instance_info.InstanceInfo`
object.
:raises `processutils.ProcessExecutionError`. Plugins implementing
:raises: `processutils.ProcessExecutionError`. Plugins implementing
this method should let `processutils.ProcessExecutionError`
bubble up.
"""