From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from pigeon.gentoo.org ([208.92.234.80] helo=lists.gentoo.org) by finch.gentoo.org with esmtp (Exim 4.60) (envelope-from ) id 1QiNMF-0008Ac-Vg for garchives@archives.gentoo.org; Sun, 17 Jul 2011 09:09:52 +0000 Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 3232921C140; Sun, 17 Jul 2011 09:09:44 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) by pigeon.gentoo.org (Postfix) with ESMTP id F194F21C140 for ; Sun, 17 Jul 2011 09:09:43 +0000 (UTC) Received: from pelican.gentoo.org (unknown [66.219.59.40]) (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 7D7B12AC005 for ; Sun, 17 Jul 2011 09:09:43 +0000 (UTC) Received: from localhost.localdomain (localhost [127.0.0.1]) by pelican.gentoo.org (Postfix) with ESMTP id E141B8003D for ; Sun, 17 Jul 2011 09:09:42 +0000 (UTC) From: "Michał Górny" To: gentoo-commits@lists.gentoo.org Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Michał Górny" Message-ID: <82e0576e1338a2a9889b8894f1612b6928cf60df.mgorny@gentoo> Subject: [gentoo-commits] proj/gentoopm:master commit in: gentoopm/basepm/ X-VCS-Repository: proj/gentoopm X-VCS-Files: gentoopm/basepm/pkg.py X-VCS-Directories: gentoopm/basepm/ X-VCS-Committer: mgorny X-VCS-Committer-Name: Michał Górny X-VCS-Revision: 82e0576e1338a2a9889b8894f1612b6928cf60df Date: Sun, 17 Jul 2011 09:09:42 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: quoted-printable X-Archives-Salt: X-Archives-Hash: c73f60c295e999380e2ab20df9158424 commit: 82e0576e1338a2a9889b8894f1612b6928cf60df Author: Micha=C5=82 G=C3=B3rny gentoo org> AuthorDate: Sun Jul 17 09:10:33 2011 +0000 Commit: Micha=C5=82 G=C3=B3rny gentoo org> CommitDate: Sun Jul 17 09:10:33 2011 +0000 URL: http://git.overlays.gentoo.org/gitweb/?p=3Dproj/gentoopm.git;= a=3Dcommit;h=3D82e0576e Clarify PMPackage docs a bit. --- gentoopm/basepm/pkg.py | 23 ++++++++++++----------- 1 files changed, 12 insertions(+), 11 deletions(-) diff --git a/gentoopm/basepm/pkg.py b/gentoopm/basepm/pkg.py index b2def74..067808f 100644 --- a/gentoopm/basepm/pkg.py +++ b/gentoopm/basepm/pkg.py @@ -55,20 +55,19 @@ class PMPackage(ABCObject): @property def key(self): """ - Return the key identifying the package. This is used by - L{pkgset.PMPackageSet.best}, to check whether the set doesn't referenc= e - more than one package. + The key identifying the package. This is used to group packages, e.g. + when choosing the best package in a set. =20 - @type: any + @type: hashable """ return self.atom.key =20 @property def id(self): """ - Return an unique identifier for the package. + An unique identifier for the package. =20 - @type: any + @type: hashable """ return self.atom =20 @@ -84,17 +83,19 @@ class PMPackage(ABCObject): @abstractproperty def path(self): """ - Return path to the ebuild file (or vardb entry) if appropriate. - If not available, just return None. + Path to the ebuild file (or vardb entry) if appropriate. =20 - @type: string/None + This function may return C{None} if that information is not available + or the particular repository doesn't operate on local filesystem. + + @type: string/C{None} """ pass =20 @abstractproperty def metadata(self): """ - Return the metadata accessor object for the package. + The metadata accessor object for the package. =20 @type: L{PMPackageMetadata} """ @@ -103,7 +104,7 @@ class PMPackage(ABCObject): @property def environ(self): """ - Return the environment accessor object for the package. + The environment accessor object for the package. =20 @type: L{PMPackageEnvironment} """