commit 02e1e07918bf4341c0656f99b01da8ee9f1499fb
author Mike Frysinger <vapier@chromium.org> Sun Nov 10 22:11:34 2013 -0500
committer chrome-internal-fetch <chrome-internal-fetch@google.com> Wed Nov 13 00:36:12 2013 +0000
tree 4e5030b248074d2d354d5c4d9cfe1a5218c933bf
parent 16a8c63702242726410c198286c5949c3a7dd745

tweak docstrings

This fixes section names:
  Arguments -> Args
  Return -> Returns

It also fixes the last line of the docstring so it isn't cuddled.

And we fix a few docstrings that should be one line but aren't.

BUG=None
TEST=`./buildbot/run_tests` passes

Change-Id: Iaafb7d346a3aee97a40dab340463894c02533091
Reviewed-on: https://chromium-review.googlesource.com/176279
Reviewed-by: Mike Frysinger <vapier@chromium.org>
Commit-Queue: Mike Frysinger <vapier@chromium.org>
Tested-by: Mike Frysinger <vapier@chromium.org>

scripts/cbuildbot.py

diff --git a/scripts/cbuildbot.py b/scripts/cbuildbot.py
index 92ec3c2..a51ea6f 100644
--- a/scripts/cbuildbot.py
+++ b/scripts/cbuildbot.py
@@ -58,7 +58,7 @@
 def _PrintValidConfigs(display_all=False):
   """Print a list of valid buildbot configs.
 
-  Arguments:
+  Args:
     display_all: Print all configs.  Otherwise, prints only configs with
                  trybot_list=True.
   """
@@ -190,7 +190,6 @@
       args: args to pass to stage constructor.
       kwargs: kwargs to pass to stage constructor.
     Returns:
-
       Whatever the stage's Run method returns.
     """
     stage_instance = self._GetStageInstance(stage, *args, **kwargs)
@@ -208,7 +207,8 @@
 
     Subclasses may override this method.
 
-    Returns: None
+    Returns:
+      None
     """
     return None
 
@@ -374,7 +374,8 @@
   def GetSyncInstance(self):
     """Sync to lkgm or TOT as necessary.
 
-    Returns: the instance of the sync stage to run.
+    Returns:
+      The instance of the sync stage to run.
     """
     if self.options.force_version:
       sync_stage = self._GetStageInstance(stages.ManifestVersionedSyncStage)
@@ -564,7 +565,8 @@
   def GetSyncInstance(self):
     """Syncs the tree using one of the distributed sync logic paths.
 
-    Returns: the instance of the sync stage to run.
+    Returns:
+      The instance of the sync stage to run.
     """
     # Determine sync class to use.  CQ overrides PFQ bits so should check it
     # first.
@@ -652,7 +654,7 @@
 def _DetermineDefaultBuildRoot(sourceroot, internal_build):
   """Default buildroot to be under the directory that contains current checkout.
 
-  Arguments:
+  Args:
     internal_build: Whether the build is an internal build
     sourceroot: Use specified sourceroot.
   """