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

558 B
Raw Blame History

vim.option.StringOption

The StringOption data object type is used to define an open-ended string value based on an optional subset of valid characters.

extends

vim.option.OptionType

Attributes:

defaultValue (str):

The default value.

validCharacters (str, optional):

The string containing the set of valid characters. If a string option is not specified, all strings are allowed.