
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
18 lines
558 B
ReStructuredText
18 lines
558 B
ReStructuredText
.. _str: https://docs.python.org/2/library/stdtypes.html
|
|
|
|
.. _vim.option.OptionType: ../../vim/option/OptionType.rst
|
|
|
|
|
|
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.
|