From: Simon Glass <simon.glass@canonical.com>
The comment for prep_series() is quite terse. Expand it to describe what
the function actually does.
Signed-off-by: Simon Glass <simon.glass@canonical.com>
---
tools/patman/cser_helper.py | 9 +++++++--
tools/patman/database.py | 2 +-
2 files changed, 8 insertions(+), 3 deletions(-)
@@ -255,11 +255,16 @@ class CseriesHelper:
def prep_series(self, name, end=None):
"""Prepare to work with a series
+ Parse the branch name to determine the series name and version
+ number, then count the commits from the upstream branch (or up to the
+ end commit if provided) and collect the series metadata from those
+ commits.
+
Args:
name (str): Branch name with version appended, e.g. 'fix2'
end (str or None): Commit to end at, e.g. 'my_branch~16'. Only
- commits up to that are processed. None to process commits up to
- the upstream branch
+ commits up to that are processed. Use None to process commits up
+ to the upstream branch
Return: tuple:
str: Series name, e.g. 'fix'
@@ -41,7 +41,7 @@ Pcommit = namedtuple(
'idnum,seq,subject,svid,change_id,state,patch_id,num_comments')
-class Database:
+class Database: # pylint:disable=R0904
"""Database of information used by patman"""
# dict of databases: