15f7be9a52
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
23 lines
1.0 KiB
ReStructuredText
23 lines
1.0 KiB
ReStructuredText
.. _str: https://docs.python.org/2/library/stdtypes.html
|
|
|
|
.. _vSphere API 4.0: ../vim/version.rst#vimversionversion5
|
|
|
|
.. _vmodl.KeyAnyValue: ../vmodl/KeyAnyValue.rst
|
|
|
|
.. _vim.ElementDescription: ../vim/ElementDescription.rst
|
|
|
|
|
|
vim.ExtendedElementDescription
|
|
==============================
|
|
|
|
:extends: vim.ElementDescription_
|
|
:since: `vSphere API 4.0`_
|
|
|
|
Attributes:
|
|
messageCatalogKeyPrefix (`str`_):
|
|
|
|
Key to the localized message string in the catalog. If the localized string contains parameters, values to the parameters will be provided in #messageArg. E.g: If the message in the catalog is "IP address is {address}", value for "address" will be provided by #messageArg. Both summary and label in ElementDescription will have a corresponding entry in the message catalog with the keys.summary and.label respectively. ElementDescription.summary and ElementDescription.label will contain the strings in server locale.
|
|
messageArg (`vmodl.KeyAnyValue`_, optional):
|
|
|
|
Provides named arguments that can be used to localize the message in the catalog.
|