Fix docstrings formatting
Fix warnings/errors reported by Sphinx
This commit is contained in:
parent
e7f717ec3d
commit
f393ce62dc
@ -325,8 +325,8 @@ class property(object): # pylint: disable=redefined-builtin,invalid-name
|
||||
setter. Can raise QubesValueError if the value is invalid.
|
||||
|
||||
:param untrusted_newvalue: value to be validated
|
||||
:return sanitized value
|
||||
:raises qubes.exc.QubesValueError
|
||||
:return: sanitized value
|
||||
:raises: qubes.exc.QubesValueError
|
||||
'''
|
||||
# do not treat type='str' as sufficient validation
|
||||
if self.type is not None and self.type is not str:
|
||||
|
@ -119,6 +119,7 @@ class BackupHeader(object):
|
||||
|
||||
:param untrusted_header_text: header content
|
||||
:type untrusted_header_text: basestring
|
||||
|
||||
.. warning::
|
||||
This function may be exposed to not yet verified header,
|
||||
so is security critical.
|
||||
|
@ -249,7 +249,7 @@ class OptionsCheckVisitor(docutils.nodes.SparseNodeVisitor):
|
||||
While the documentation talks about a
|
||||
'SparseNodeVisitor.depart_document()' function, this function does
|
||||
not exists. (For details see implementation of
|
||||
:py:method:`NodeVisitor.dispatch_departure()`) So we need to
|
||||
:py:meth:`NodeVisitor.dispatch_departure()`) So we need to
|
||||
manually call this.
|
||||
'''
|
||||
if ignored_options is None:
|
||||
@ -316,7 +316,7 @@ class CommandCheckVisitor(docutils.nodes.SparseNodeVisitor):
|
||||
While the documentation talks about a
|
||||
'SparseNodeVisitor.depart_document()' function, this function does
|
||||
not exists. (For details see implementation of
|
||||
:py:method:`NodeVisitor.dispatch_departure()`) So we need to
|
||||
:py:meth:`NodeVisitor.dispatch_departure()`) So we need to
|
||||
manually call this.
|
||||
'''
|
||||
if self.sub_commands:
|
||||
|
@ -304,10 +304,12 @@ class QubesArgumentParser(argparse.ArgumentParser):
|
||||
:param bool want_force_root: add ``--force-root`` option
|
||||
:param mixed vmname_nargs: The number of ``VMNAME`` arguments that should be
|
||||
consumed. Values include:
|
||||
|
||||
- N (an integer) consumes N arguments (and produces a list)
|
||||
- '?' consumes zero or one arguments
|
||||
- '*' consumes zero or more arguments (and produces a list)
|
||||
- '+' consumes one or more arguments (and produces a list)
|
||||
|
||||
*kwargs* are passed to :py:class:`argparser.ArgumentParser`.
|
||||
|
||||
Currenty supported options:
|
||||
|
@ -578,7 +578,7 @@ class QubesVM(qubes.vm.mix.net.NetVMMixin, qubes.vm.BaseVM):
|
||||
|
||||
@property
|
||||
def block_devices(self):
|
||||
''' Return all :py:class:`qubes.storage.BlockDevice`s for current domain
|
||||
''' Return all :py:class:`qubes.storage.BlockDevice` for current domain
|
||||
for serialization in the libvirt XML template as <disk>.
|
||||
'''
|
||||
for v in self.volumes.values():
|
||||
|
Loading…
Reference in New Issue
Block a user