diff options
author | Michal Minar <miminar@redhat.com> | 2013-09-20 14:34:37 +0200 |
---|---|---|
committer | Michal Minar <miminar@redhat.com> | 2013-09-21 14:11:11 +0200 |
commit | 0bdf31e019bd1a115af91f7c5dcf8fecf6fe1cbb (patch) | |
tree | 19d849079bc87948d92f23a2fc9398623de50d3d /lmi/scripts/common/command/multiplexer.py | |
parent | ac66191bac03a5c1026706c2db917083362d3874 (diff) | |
download | openlmi-scripts-0bdf31e019bd1a115af91f7c5dcf8fecf6fe1cbb.tar.gz openlmi-scripts-0bdf31e019bd1a115af91f7c5dcf8fecf6fe1cbb.tar.xz openlmi-scripts-0bdf31e019bd1a115af91f7c5dcf8fecf6fe1cbb.zip |
documentation improvements
Use relative references to lmi.scripts components where possible.
Use '~' at the beginning of references to show just the last component
of path (lmi.scripts.common.*) is just too long.
Doc string corrections in formatter.
Diffstat (limited to 'lmi/scripts/common/command/multiplexer.py')
-rw-r--r-- | lmi/scripts/common/command/multiplexer.py | 8 |
1 files changed, 3 insertions, 5 deletions
diff --git a/lmi/scripts/common/command/multiplexer.py b/lmi/scripts/common/command/multiplexer.py index cf55ef3..829d90f 100644 --- a/lmi/scripts/common/command/multiplexer.py +++ b/lmi/scripts/common/command/multiplexer.py @@ -59,10 +59,9 @@ class LmiCommandMultiplexer(base.LmiBaseCommand): ``COMMANDS`` property will be translated to :py:meth:`LmiCommandMultiplexer.child_commands` class method by - :py:class:`lmi.scripts.common.command.meta.MultiplexerMetaClass`. + :py:class:`~.meta.MultiplexerMetaClass`. - Using metaclass: - :py:class:`lmi.scripts.common.command.meta.MultiplexerMetaClass`. + Using metaclass: :py:class:`.meta.MultiplexerMetaClass`. """ __metaclass__ = meta.MultiplexerMetaClass @@ -88,8 +87,7 @@ class LmiCommandMultiplexer(base.LmiBaseCommand): Pass control to a subcommand identified by given name. :param string cmd_name: Name of direct subcommand, whose - :py:meth:`lmi.scripts.common.command.base.LmiBaseCommand.run` - method shall be invoked. + :py:meth:`~.base.LmiBaseCommand.run` method shall be invoked. :param list args: List of arguments for particular subcommand. :returns: Application exit code. :rtype: integer |