Add a docstring to config.getMissingLicenses().

svn path=/main/trunk/; revision=6259

diff --git a/pym/portage/__init__.py b/pym/portage/__init__.py
index 485f89e06b8a26b78d0dc81247cebf44c31784d9..11dca580a55e136be081898690f8e491e674af20 100644 (file)
--- a/pym/portage/__init__.py
+++ b/pym/portage/__init__.py
@@ -1749,6 +1749,19 @@ class config:
                        self.reset(keeping_pkg=1,use_cache=use_cache)
 
        def getMissingLicenses(self, licenses, cpv):
+               """
+               Take a LICENSE string and return a list any licenses that the user may
+               may need to accept for the given package.  The returned list will not
+               contain any licenses that have already been accepted.  This method
+               can throw an InvalidDependString exception.
+
+               @param licenses: A raw LICENSE string as returned form dbapi.aux_get()
+               @type licenses: String
+               @param cpv: The package name (for evaluation of USE conditionals)
+               @type cpv: String
+               @rtype: List
+               @return: A list of licenses that have not been accepted.
+               """
                cpdict = self._plicensedict.get(dep_getkey(cpv), None)
                acceptable_licenses = self._accept_license.copy()
                if cpdict: