From 0bdf31e019bd1a115af91f7c5dcf8fecf6fe1cbb Mon Sep 17 00:00:00 2001 From: Michal Minar Date: Fri, 20 Sep 2013 14:34:37 +0200 Subject: 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. --- lmi/scripts/common/command/multiplexer.py | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) (limited to 'lmi/scripts/common/command/multiplexer.py') 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 -- cgit