[yum-cvs] 3 commits - Makefile callback.py yummain.py

[James Bowes]

 Makefile    |   11 +++++++----
 callback.py |    8 ++++++++
 yummain.py  |    3 +++
 3 files changed, 18 insertions(+), 4 deletions(-)

New commits:
commit 0e91c1eb30100d0040eb78d21d4c04fa78b0c006
Author: James Bowes <jbowes at redhat.com>
Date:   Sun Oct 7 16:03:17 2007 -0400

    Add docstring for yummain.py

diff --git a/yummain.py b/yummain.py
index 3034d36..6b9663a 100755
--- a/yummain.py
+++ b/yummain.py
@@ -14,6 +14,9 @@
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 # Copyright 2005 Duke University 
 
+"""
+Entrance point for the yum command line interface.
+"""
 
 import sys
 import locale
commit 5bf89b983c17416535c0a137e68f7e37f1898308
Author: James Bowes <jbowes at redhat.com>
Date:   Sun Oct 7 15:44:20 2007 -0400

    Add some docstrings to callback.py

diff --git a/callback.py b/callback.py
index d11e604..3c25ca8 100644
--- a/callback.py
+++ b/callback.py
@@ -14,6 +14,9 @@
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 # Copyright 2005 Duke University
 
+"""
+Progress display callback classes for the yum command line.
+"""
 
 import rpm
 import os
@@ -24,6 +27,11 @@ from yum.constants import *
 from i18n import _
 
 class RPMInstallCallback:
+
+    """
+    Yum command line callback class for callbacks from the RPM library.
+    """
+
     def __init__(self, output=1):
         self.output = output
         self.callbackfilehandles = {}
commit 068670dd503201dcf908144585bc232ddf63bb89
Author: James Bowes <jbowes at redhat.com>
Date:   Sun Oct 7 15:37:15 2007 -0400

    Add a doccheck Makefile target for epydoc completeness.

diff --git a/Makefile b/Makefile
index 62121e3..300534f 100644
--- a/Makefile
+++ b/Makefile
@@ -34,11 +34,14 @@ install:
 	for d in $(SUBDIRS); do make PYTHON=$(PYTHON) DESTDIR=`cd $(DESTDIR); pwd` -C $$d install; [ $$? = 0 ] || exit 1; done
 
 .PHONY: docs test
+
+DOCS = yum rpmUtils callback.py progress_meter.py yumcommands.py shell.py \
+	   translate.py output.py i18n.py cli.py yummain.py
 docs:
-	epydoc -n yum -o docs/epydoc -u http://linux.duke.edu/projects/yum \
-			yum yum-updatesd.py rpmUtils callback.py progress_meter.py \
-			yumcommands.py shell.py translate.py output.py i18n.py cli.py \
-			yummain.py
+	epydoc -n yum -o docs/epydoc -u http://linux.duke.edu/projects/yum $(DOCS)
+
+doccheck:
+	epydoc --check $(DOCS)
 
 test:
 	python test/alltests.py