openstack/deb-python-pyvmomi
Code Issues Proposed changes
Files
master
deb-python-pyvmomi/docs/vim/option/BoolOption.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

511 B
Raw Permalink Blame History

vim.option.BoolOption

The BoolOption data object type describes if an option is supported ("true") and if the option is set to "true" or "false" by default.

extends

vim.option.OptionType

Attributes:

supported (bool):

The flag to indicate whether or not the option is supported.

defaultValue (bool):

The default value for the option.