diff options
author | Mike Frysinger <vapier@chromium.org> | 2013-12-12 01:50:59 -0500 |
---|---|---|
committer | chrome-internal-fetch <chrome-internal-fetch@google.com> | 2013-12-13 01:13:48 +0000 |
commit | 1a736a878a49515ab2198e3cba66ad5162791f7c (patch) | |
tree | 432ffb3a935bdf94d5faa20f9d14206bdb8cbaa8 /lib/patch.py | |
parent | 5b9551453b495666364a5c7b42562c7f68535a24 (diff) | |
download | chromite-1a736a878a49515ab2198e3cba66ad5162791f7c.tar.gz |
lint: clean up section names in docstrings
Make sure:
- correct ordering
- correct name usage
- new lines before each section
Maybe one or two other random fixes too like whitespace alignment.
BUG=chromium:327969
TEST=`cros lint` doesn't complain as much
TEST=`./buildbot/run_tests` passes
Change-Id: Ia57f06d5c0709103b2373568989d03d8fbaceeb5
Reviewed-on: https://chromium-review.googlesource.com/179802
Reviewed-by: Matt Tennant <mtennant@chromium.org>
Commit-Queue: Mike Frysinger <vapier@chromium.org>
Tested-by: Mike Frysinger <vapier@chromium.org>
Diffstat (limited to 'lib/patch.py')
-rw-r--r-- | lib/patch.py | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/lib/patch.py b/lib/patch.py index 16f43a1fa..59fb0f9fc 100644 --- a/lib/patch.py +++ b/lib/patch.py @@ -546,6 +546,7 @@ class GitRepoPatch(object): Args: git_repo: The git repository to fetch this patch into. + Returns: The sha1 of the patch. """ @@ -609,7 +610,8 @@ class GitRepoPatch(object): Args: git_repo: Git repository to operate upon. - returns: A dictionary of path -> modification_type tuples. See + Returns: + A dictionary of path -> modification_type tuples. See `git log --help`, specifically the --diff-filter section for details. """ @@ -903,14 +905,14 @@ class GitRepoPatch(object): def GetCheckout(self, manifest, strict=True): """Get the ProjectCheckout associated with this patch. - Raises: - ChangeMatchesMultipleCheckouts if there are multiple checkouts that - match this change. - Args: manifest: A ManifestCheckout object. strict: If the change refers to a project/branch that is not in the manifest, raise a ChangeNotInManifest error. + + Raises: + ChangeMatchesMultipleCheckouts if there are multiple checkouts that + match this change. """ checkouts = manifest.FindCheckouts(self.project, self.tracking_branch) if len(checkouts) != 1: @@ -1020,6 +1022,7 @@ class LocalPatch(GitRepoPatch): dryrun: Do the git push with --dry-run reviewers: Iterable of reviewers to add. cc: Iterable of people to add to cc. + Returns: A list of gerrit URLs found in the output """ @@ -1271,6 +1274,7 @@ class GerritPatch(GitRepoPatch): Args: field: Which field to check ('VRIF', 'CRVW', ...). + Returns: Most recent field value (as str) or '0' if no such field. """ |