[Yum-devel] [PATCH] Adds and modifies documentation for the yum.__init__ module.

[James Antill]

On Wed, 2011-08-10 at 13:46 -0400, Nick Jacek wrote:
> ---
>  yum/__init__.py |  911 +++++++++++++++++++++++++++++++++++++++----------------
>  1 files changed, 642 insertions(+), 269 deletions(-)

 Doesn't apply again HEAD. Also:

[...]
> @@ -1759,8 +1849,11 @@ class YumBase(depsolve.Depsolve):
>          self.pkgSack.addPackageExcluder(repo.id, exid, 'exclude.marked')
>          
>      def doLock(self, lockfile = YUM_PID_FILE):
> -        """perform the yum locking, raise yum-based exceptions, not OSErrors"""
> -        
> +        """Close the yum lock.
> +
> +        :param lockfile: the file to use for the lock
> +        :raises: :class:`yum.Errors.LockError`
> +        """
>          if self.conf.uid != 0:
>              #  If we are a user, assume we are using the root cache ... so don't
>              # bother locking.

 Not sure what you meant to say here, but "Close" isn't right.

> @@ -1853,10 +1950,19 @@ class YumBase(depsolve.Depsolve):
>          misc.unlink_f(filename)
>  
>      def verifyPkg(self, fo, po, raiseError):
> -        """verifies the package is what we expect it to be
> -           raiseError  = defaults to 0 - if 1 then will raise
> -           a URLGrabError if the file does not check out.
> -           otherwise it returns false for a failure, true for success"""
> +        """Check that the package is what we expect it to be

 Maybe say "check the checksum of a remote package against what we
expect it to be"? Also maybe mention the magic deleting it does?

> @@ -2274,8 +2434,29 @@ class YumBase(depsolve.Depsolve):
>  
>      def doPackageLists(self, pkgnarrow='all', patterns=None, showdups=None,
>                         ignore_case=False):
> -        """generates lists of packages, un-reduced, based on pkgnarrow option"""
> -
> +        """Return a :class:`yum.misc.enericHolder` containing

 Minor typo.