Title: [225500] trunk/Tools
Revision
225500
Author
aakash_j...@apple.com
Date
2017-12-04 16:03:38 -0800 (Mon, 04 Dec 2017)

Log Message

Add docstring in EarlyWarningSystemTask to explain return values
https://bugs.webkit.org/show_bug.cgi?id=180303

Reviewed by Daniel Bates.

* Scripts/webkitpy/tool/bot/earlywarningsystemtask.py:
(EarlyWarningSystemTask.run): Added docstring to explain return values.
* Scripts/webkitpy/tool/commands/earlywarningsystem.py:
(AbstractEarlyWarningSystem.review_patch): Added comment to explain the result of unlocking a patch.

Modified Paths

Diff

Modified: trunk/Tools/ChangeLog (225499 => 225500)


--- trunk/Tools/ChangeLog	2017-12-04 23:34:57 UTC (rev 225499)
+++ trunk/Tools/ChangeLog	2017-12-05 00:03:38 UTC (rev 225500)
@@ -1,3 +1,15 @@
+2017-12-04  Aakash Jain  <aakash_j...@apple.com>
+
+        Add docstring in EarlyWarningSystemTask to explain return values
+        https://bugs.webkit.org/show_bug.cgi?id=180303
+
+        Reviewed by Daniel Bates.
+
+        * Scripts/webkitpy/tool/bot/earlywarningsystemtask.py:
+        (EarlyWarningSystemTask.run): Added docstring to explain return values.
+        * Scripts/webkitpy/tool/commands/earlywarningsystem.py:
+        (AbstractEarlyWarningSystem.review_patch): Added comment to explain the result of unlocking a patch.
+
 2017-12-04  JF Bastien  <jfbast...@apple.com>
 
         Update std::expected to match libc++ coding style

Modified: trunk/Tools/Scripts/webkitpy/tool/bot/earlywarningsystemtask.py (225499 => 225500)


--- trunk/Tools/Scripts/webkitpy/tool/bot/earlywarningsystemtask.py	2017-12-04 23:34:57 UTC (rev 225499)
+++ trunk/Tools/Scripts/webkitpy/tool/bot/earlywarningsystemtask.py	2017-12-05 00:03:38 UTC (rev 225500)
@@ -54,6 +54,12 @@
         return True
 
     def run(self):
+        """
+        Returns True if the patch passes EWS.
+        Raises an exception if the patch fails EWS.
+        Returns False if the patch status can not be ascertained. AbstractEarlyWarningSystem.review_patch()
+        will unlock the patch so that it would be retried.
+        """
         if not self._clean():
             return False
         if not self._update():

Modified: trunk/Tools/Scripts/webkitpy/tool/commands/earlywarningsystem.py (225499 => 225500)


--- trunk/Tools/Scripts/webkitpy/tool/commands/earlywarningsystem.py	2017-12-04 23:34:57 UTC (rev 225499)
+++ trunk/Tools/Scripts/webkitpy/tool/commands/earlywarningsystem.py	2017-12-05 00:03:38 UTC (rev 225500)
@@ -102,6 +102,7 @@
             succeeded = task.run()
             if not succeeded:
                 # Caller unlocks when review_patch returns True, so we only need to unlock on transient failure.
+                # Unlocking the patch would result in patch being re-tried.
                 self._unlock_patch(patch)
             return succeeded
         except PatchIsNotValid as error:
_______________________________________________
webkit-changes mailing list
webkit-changes@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-changes

Reply via email to