aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRahul Chaudhry <rahulchaudhry@chromium.org>2016-01-15 14:30:14 -0800
committerchrome-bot <chrome-bot@chromium.org>2016-01-23 04:08:55 +0000
commite57523abd8f2a5aa0b93f1248d6d969d0865781b (patch)
treef0f412c1600243450bfba5bea934628dda360d8f
parent88272d479f2761cc1906fea564c73033f77a6270 (diff)
downloadtoolchain-utils-e57523abd8f2a5aa0b93f1248d6d969d0865781b.tar.gz
toolchain-utils: fix module-missing-docstring lint warnings.
BUG=chromium:570458 TEST='crosperf/run_tests.sh' passes. Change-Id: Ifda134bf5f26db04551b915c189814b86e750df3 Reviewed-on: https://chrome-internal-review.googlesource.com/244866 Commit-Ready: Rahul Chaudhry <rahulchaudhry@google.com> Tested-by: Rahul Chaudhry <rahulchaudhry@google.com> Reviewed-by: Luis Lozano <llozano@chromium.org>
-rwxr-xr-xbinary_search_tool/cros_pkg/cros_pkg_create_cleanup_script.py15
-rwxr-xr-xbinary_search_tool/cros_pkg/cros_pkg_undo_eclean.py17
-rwxr-xr-xbinary_search_tool/test/common.py1
-rwxr-xr-xcrosperf/experiment_runner_unittest.py1
-rw-r--r--crosperf/suite_runner.py1
-rw-r--r--utils/file_utils.py1
-rw-r--r--utils/html_tools.py2
-rw-r--r--utils/logger.py1
8 files changed, 23 insertions, 16 deletions
diff --git a/binary_search_tool/cros_pkg/cros_pkg_create_cleanup_script.py b/binary_search_tool/cros_pkg/cros_pkg_create_cleanup_script.py
index 0e5ba20a..fc479c92 100755
--- a/binary_search_tool/cros_pkg/cros_pkg_create_cleanup_script.py
+++ b/binary_search_tool/cros_pkg/cros_pkg_create_cleanup_script.py
@@ -1,13 +1,14 @@
#!/usr/bin/python2
#
# Copyright 2015 Google Inc. All Rights Reserved
-#
-# This script takes a set of flags, telling it what cros_pkg_setup.sh changed
-# during the set up process. Based on the values of the input flags, it
-# generates a cleanup script, named cros_pkg_${BOARD}_cleanup.sh, which will
-# undo the changes made by cros_pkg_setup.sh, returning everything to its
-# original state.
-#
+"""The script to generate a cleanup script after cros_pkg_setup.sh.
+
+This script takes a set of flags, telling it what cros_pkg_setup.sh changed
+during the set up process. Based on the values of the input flags, it
+generates a cleanup script, named cros_pkg_${BOARD}_cleanup.sh, which will
+undo the changes made by cros_pkg_setup.sh, returning everything to its
+original state.
+"""
from __future__ import print_function
diff --git a/binary_search_tool/cros_pkg/cros_pkg_undo_eclean.py b/binary_search_tool/cros_pkg/cros_pkg_undo_eclean.py
index ed934c47..a08651ed 100755
--- a/binary_search_tool/cros_pkg/cros_pkg_undo_eclean.py
+++ b/binary_search_tool/cros_pkg/cros_pkg_undo_eclean.py
@@ -1,14 +1,15 @@
#!/usr/bin/python2
#
# Copyright 2015 Google Inc. All Rights Reserved.
-#
-# This script takes a single argument, the name of a file (normally expected to
-# be 'build_image'), which should be a shell script. It then creates a new
-# output file, named <input_file>.edited, and it copies each line from the
-# input file to the output file. If the line from the input file contains the
-# string 'eclean', it prepends a '#' to the line before copying it to the
-# output file, in effect commenting out any lines that contain 'eclean'.
-#
+"""Comment out eclean invocations from input script.
+
+This script takes a single argument, the name of a file (normally expected to
+be 'build_image'), which should be a shell script. It then creates a new
+output file, named <input_file>.edited, and it copies each line from the
+input file to the output file. If the line from the input file contains the
+string 'eclean', it prepends a '#' to the line before copying it to the
+output file, in effect commenting out any lines that contain 'eclean'.
+"""
from __future__ import print_function
diff --git a/binary_search_tool/test/common.py b/binary_search_tool/test/common.py
index 5a5a5241..baac9434 100755
--- a/binary_search_tool/test/common.py
+++ b/binary_search_tool/test/common.py
@@ -1,4 +1,5 @@
#!/usr/bin/python2
+"""Common utility functions."""
DEFAULT_OBJECT_NUMBER = 1238
DEFAULT_BAD_OBJECT_NUMBER = 23
diff --git a/crosperf/experiment_runner_unittest.py b/crosperf/experiment_runner_unittest.py
index 6019b8bd..2fc512d9 100755
--- a/crosperf/experiment_runner_unittest.py
+++ b/crosperf/experiment_runner_unittest.py
@@ -1,6 +1,7 @@
#!/usr/bin/python2
#
# Copyright 2014 Google Inc. All Rights Reserved
+"""Tests for the experiment runner module."""
from __future__ import print_function
diff --git a/crosperf/suite_runner.py b/crosperf/suite_runner.py
index ae502bde..b75427f2 100644
--- a/crosperf/suite_runner.py
+++ b/crosperf/suite_runner.py
@@ -1,6 +1,7 @@
# Copyright (c) 2013 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
+"""SuiteRunner defines the interface from crosperf to test script."""
from __future__ import print_function
diff --git a/utils/file_utils.py b/utils/file_utils.py
index 9cb441a3..08e5cdc8 100644
--- a/utils/file_utils.py
+++ b/utils/file_utils.py
@@ -1,4 +1,5 @@
# Copyright 2011 Google Inc. All Rights Reserved.
+"""Utilities for operations on files."""
from __future__ import print_function
diff --git a/utils/html_tools.py b/utils/html_tools.py
index dc342f9e..8ca795bf 100644
--- a/utils/html_tools.py
+++ b/utils/html_tools.py
@@ -1,5 +1,5 @@
# Copyright 2010 Google Inc. All Rights Reserved.
-#
+"""Utilities for generating html."""
def GetPageHeader(page_title):
diff --git a/utils/logger.py b/utils/logger.py
index 02b4511b..c652c8e6 100644
--- a/utils/logger.py
+++ b/utils/logger.py
@@ -1,4 +1,5 @@
# Copyright 2010 Google Inc. All Rights Reserved.
+"""Logging helper module."""
from __future__ import print_function