Improve comments wording in fedabipkgdiff

While looking at something else, it struck me that we could use some
better wording in the comments for the RPM class.

	* tools/fedabipkgdiff (class RPM): Fix wording.
	(RPM::__init__): Likewise.

Signed-off-by: Dodji Seketeli <dodji@redhat.com>
This commit is contained in:
Dodji Seketeli 2017-12-15 11:00:51 +01:00
parent d57639c051
commit 6b7f1c28a0

View File

@ -263,17 +263,18 @@ def delete_download_cache():
class RPM(object):
"""Wrapper of RPM representing a RPM got from Koji
"""Wrapper around an RPM descriptor received from Koji
A RPM is returned from Koji XMLRPC API is in dict type. This wrapper makes
it eaiser to access all these properties in the way of object.property.
The RPM descriptor that is returned from Koji XMLRPC API is a
dict. This wrapper class makes it eaiser to access all these
properties in the way of object.property.
"""
def __init__(self, rpm_info):
"""Initialize a RPM object
:param dict rpm_info: a dict representing a RPM information got from
koji API, either listRPMs or getRPM
:param dict rpm_info: a dict representing an RPM descriptor
received from the Koji API, either listRPMs or getRPM
"""
self.rpm_info = rpm_info