abssymlink: clarify docs, bug #225821
authorZac Medico <zmedico@gentoo.org>
Fri, 15 Feb 2013 22:34:36 +0000 (14:34 -0800)
committerZac Medico <zmedico@gentoo.org>
Fri, 15 Feb 2013 22:34:36 +0000 (14:34 -0800)
pym/portage/__init__.py

index bc14bae381fb6909033e957f1fd8f0556aaca25b..f326ecb07d10fe5dacc03c2f609de003a8bb858a 100644 (file)
@@ -464,7 +464,15 @@ def getcwd():
 getcwd()
 
 def abssymlink(symlink, target=None):
-       "This reads symlinks, resolving the relative symlinks, and returning the absolute."
+       """
+       This reads symlinks, resolving the relative symlinks,
+       and returning the absolute.
+       @param symlink: path of symlink (must be absolute)
+       @param target: the target of the symlink (as returned
+               by readlink)
+       @rtype: str
+       @return: the absolute path of the symlink target
+       """
        if target is not None:
                mylink = target
        else: