Files
deb-python-pyvmomi/docs/vim/vm/FileLayout/SnapshotLayout.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

20 lines
586 B
ReStructuredText

.. _str: https://docs.python.org/2/library/stdtypes.html
.. _vim.vm.Snapshot: ../../../vim/vm/Snapshot.rst
.. _vmodl.DynamicData: ../../../vmodl/DynamicData.rst
vim.vm.FileLayout.SnapshotLayout
================================
Enumerates the set of files that make up a snapshot or redo-point
:extends: vmodl.DynamicData_
Attributes:
key (`vim.vm.Snapshot`_):
Identification of the snapshot
snapshotFile (`str`_):
A list of files that make up the snapshot state. These are relative paths from the snapshotDirectory. A slash is always used as a separator.