Files
deb-python-pyvmomi/docs/vim/option/OptionValue.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation
This external documentation for pyVmomi was generated using Googly Docs
(aka Google Standard Documentation) which renders very cleanly in
GitHub. Internal documentation for a class should be done in Sphinx
format because tools like pyCharm and Eclipse can use that documentation
as a hint for code completion.

Note: External docs as Googly Docs, internal docs as Sphinx.

Closes bug#15
2014-06-17 14:07:42 -04:00

843 B

vim.option.OptionValue

Describes the key/value pair of a configured option.

extends

vmodl.DynamicData

Attributes:

key (str):

The name of the option using dot notation to reflect the option's position in a hierarchy. For example, you might have an option called "Ethernet" and another option that is a child of that called "Connection". In this case, the key for the latter could be defined as "Ethernet.Connection"

value (object, optional):

The value of the option. The Any data object type enables you to define any value for the option. Typically, however, the value of an option is of type String or Integer.