Files
deb-python-pyvmomi/docs/vim/option/OptionDef.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

17 lines
784 B
ReStructuredText

.. _ElementDescription: ../../vim/ElementDescription.rst
.. _vim.option.OptionType: ../../vim/option/OptionType.rst
.. _vim.ElementDescription: ../../vim/ElementDescription.rst
vim.option.OptionDef
====================
Describes a user-defined option. The name of each option is identified by the "key" property, inherited from the `ElementDescription`_ data object type. You can indicate the property's position in a hierarchy by using a dot-separated notation. The string preceding the first dot is the top of the hierarchy. The hierarchy descends to a new sublevel with each dot. For example, "Ethernet.NetworkConnection.Bridged".
:extends: vim.ElementDescription_
Attributes:
optionType (`vim.option.OptionType`_):
The option type which defines allowed values.