os-vif/doc/source/user
Eric Fried 8d7c0d548d doc: Fix arg specs and object types in docs
The usage doc stated that plug and unplug accept a single argument of
type `os_vif.objects.VIF`, which isn't a thing, and then went on to give
an example showing that they take two.  The usage doc and the plug and
unplug docstrings also listed various objects at the wrong paths (e.g.
the `instance_info` param being of type `os_vif.objects.InstanceInfo`,
which also isn't a thing).

Fixed up the usage doc to list both arguments and correct the references
in the sample code; and fixed the plug/unplug docstrings
to list the proper paths to classes: os_vif.objects.vif.VIFBase and
os_vif.objects.instance_info.InstanceInfo.

Made everything in `single backticks` into a proper rst ``literal``.

Change-Id: I400838bbe9663917fe2c64f52975b77a370405b4
2018-07-16 17:55:22 +01:00
..
plugins doc: Fix formatting issues 2018-07-05 17:25:49 +01:00
host-info.rst doc: Create directory structure for docs migration 2017-07-04 10:08:01 +01:00
usage.rst doc: Fix arg specs and object types in docs 2018-07-16 17:55:22 +01:00
vif-types.rst Add support for VIFPortProfileOVSRepresentor 2017-07-18 20:56:55 +00:00