[autotest] Fix docstrings
BUG=chromium:672348
TEST=None
Change-Id: I40811f914ed9acaacd35a3718fa66751ffb30882
Reviewed-on: https://chromium-review.googlesource.com/452964
Commit-Ready: Allen Li <ayatane@chromium.org>
Tested-by: Allen Li <ayatane@chromium.org>
Reviewed-by: Aviv Keshet <akeshet@chromium.org>
diff --git a/server/cros/dynamic_suite/suite.py b/server/cros/dynamic_suite/suite.py
index a324a33..90589d7 100644
--- a/server/cros/dynamic_suite/suite.py
+++ b/server/cros/dynamic_suite/suite.py
@@ -460,7 +460,22 @@
def _get_cf_retriever(cf_getter):
- """Returns the correct _ControlFileRetriever instance."""
+ """Return the correct _ControlFileRetriever instance.
+
+ If cf_getter is a File system ControlFileGetter, return a
+ _ControlFileRetriever. This performs a full parse of the root
+ directory associated with the getter. This is the case when it's
+ invoked from suite_preprocessor.
+
+ If cf_getter is a devserver getter, return a
+ _BatchControlFileRetriever. This looks up the suite_name in a suite
+ to control file map generated at build time, and parses the relevant
+ control files alone. This lookup happens on the devserver, so as far
+ as this method is concerned, both cases are equivalent. If
+ enable_controls_in_batch is switched on, this function will call
+ cf_getter.get_suite_info() to get a dict of control files and
+ contents in batch.
+ """
if _should_batch_with(cf_getter):
return _BatchControlFileRetriever(cf_getter)
else:
@@ -498,24 +513,7 @@
def find_test_control_data_for_suite(
self, suite_name='',
forgiving_parser=True, run_prod_code=False, test_args=None):
- """
- Function to scan through all tests and find all tests.
-
- When this method is called with a file system ControlFileGetter, or
- enable_controls_in_batch is set as false, this function will looks at
- control files returned by cf_getter.get_control_file_list() for tests.
-
- If cf_getter is a File system ControlFileGetter, it performs a full
- parse of the root directory associated with the getter. This is the
- case when it's invoked from suite_preprocessor.
-
- If cf_getter is a devserver getter it looks up the suite_name in a
- suite to control file map generated at build time, and parses the
- relevant control files alone. This lookup happens on the devserver,
- so as far as this method is concerned, both cases are equivalent. If
- enable_controls_in_batch is switched on, this function will call
- cf_getter.get_suite_info() to get a dict of control files and contents
- in batch.
+ """Scan through all tests and find all tests.
@param suite_name: If specified, this method will attempt to restrain
the search space to just this suite's control files.
