Remove get_footers patch_text TODO

Removes a TODO to remove the patch_text argument and its uses from
get_footers and related methods. The TODO indicated that it was
only used in example code, and thus should be handled another way.
However, it turns out that there is at least one legitimate use of
thus functionality downstream to retrieve footers from CL
descriptions earlier revisions.

Fixed: 1179039
Change-Id: I79996f6053a6769043943de39735b2b5d7ee02ee
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/tools/depot_tools/+/4283342
Reviewed-by: Robbie Iannucci <iannucci@chromium.org>
Auto-Submit: Brian Sheedy <bsheedy@chromium.org>
Commit-Queue: Brian Sheedy <bsheedy@chromium.org>
changes/42/4283342/7
Brian Sheedy 2 years ago committed by LUCI CQ
parent bc1d9947f6
commit 3971323b1d

@ -877,11 +877,11 @@ Args:
Returned paths will be relative to to api.path['root']. Returned paths will be relative to to api.path['root'].
&mdash; **def [get\_footer](/recipes/recipe_modules/tryserver/api.py#376)(self, tag, patch_text=None):** &mdash; **def [get\_footer](/recipes/recipe_modules/tryserver/api.py#374)(self, tag, patch_text=None):**
Gets a specific tag from a CL description Gets a specific tag from a CL description
&mdash; **def [get\_footers](/recipes/recipe_modules/tryserver/api.py#338)(self, patch_text=None):** &mdash; **def [get\_footers](/recipes/recipe_modules/tryserver/api.py#336)(self, patch_text=None):**
Retrieves footers from the patch description. Retrieves footers from the patch description.
@ -900,11 +900,11 @@ Returns true iff the properties exist to match a Gerrit issue.
Returns true iff we have a change to check out. Returns true iff we have a change to check out.
&mdash; **def [normalize\_footer\_name](/recipes/recipe_modules/tryserver/api.py#384)(self, footer):** &mdash; **def [normalize\_footer\_name](/recipes/recipe_modules/tryserver/api.py#382)(self, footer):**
&mdash; **def [require\_is\_tryserver](/recipes/recipe_modules/tryserver/api.py#221)(self):** &mdash; **def [require\_is\_tryserver](/recipes/recipe_modules/tryserver/api.py#221)(self):**
&mdash; **def [set\_change](/recipes/recipe_modules/tryserver/api.py#387)(self, change):** &mdash; **def [set\_change](/recipes/recipe_modules/tryserver/api.py#385)(self, change):**
Set the gerrit change for this module. Set the gerrit change for this module.

@ -333,8 +333,6 @@ class TryserverApi(recipe_api.RecipeApi):
""" """
self._set_failure_type('TEST_EXPIRED') self._set_failure_type('TEST_EXPIRED')
# TODO(crbug.com/1179039): switch the test in examples/full.py to not use
# patch_text, and drop the argument entirely from all the get_footer variants.
def get_footers(self, patch_text=None): def get_footers(self, patch_text=None):
"""Retrieves footers from the patch description. """Retrieves footers from the patch description.

Loading…
Cancel
Save