[yum-git] yumcommands.py

[James Bowes]

 yumcommands.py |    7 +++++++
 1 file changed, 7 insertions(+)

New commits:
commit 92d77c6b403b35ae21c79d81c595f80aceb5aebf
Author: James Bowes <jbowes at redhat.com>
Date:   Wed Jan 23 09:08:27 2008 -0500

    Add docstring for yumcommands.checkShellArg

diff --git a/yumcommands.py b/yumcommands.py
index f236ec8..bc066a3 100644
--- a/yumcommands.py
+++ b/yumcommands.py
@@ -90,6 +90,13 @@ def checkCleanArg(base, basecmd, extcmds):
             raise cli.CliError
 
 def checkShellArg(base, basecmd, extcmds):
+    """
+    Verify that the arguments given to 'yum shell' are valid.
+
+    yum shell can be given either no args, or exactly one argument,
+    which is the name of a file. If these are not met,
+    raise cli.CliError.
+    """
     if len(extcmds) == 0:
         base.verbose_logger.debug("No argument to shell")
         pass