[webkit-reviews] review granted: [Bug 180303] Add docstring in EarlyWarningSystemTask to explain return values : [Attachment 328202] Proposed patch

[bugzilla-daemon at webkit.org]

Daniel Bates <dbates at webkit.org> has granted Aakash Jain
<aakash_jain at apple.com>'s request for review:
Bug 180303: Add docstring in EarlyWarningSystemTask to explain return values
https://bugs.webkit.org/show_bug.cgi?id=180303

Attachment 328202: Proposed patch

https://bugs.webkit.org/attachment.cgi?id=328202&action=review




--- Comment #2 from Daniel Bates <dbates at webkit.org> ---
Comment on attachment 328202
  --> https://bugs.webkit.org/attachment.cgi?id=328202
Proposed patch

View in context: https://bugs.webkit.org/attachment.cgi?id=328202&action=review

> Tools/Scripts/webkitpy/tool/bot/earlywarningsystemtask.py:61
> +	   """

Could named constants help make this clearer And let us simplify this comment
to just explain that an exception indicates patch failure (e.g. RETRY = False,
PASS => True)?

If you have your heart set on this comment then “would be”  => “will be”. Also
does the formatting of this docstring match the formatting of other docstrings
that explain return values and/or exceptions?