From 521e536416774193fba2ab61efb0324310a922e6 Mon Sep 17 00:00:00 2001 From: Eduardo Gonzalez Date: Thu, 4 May 2017 09:23:41 +0100 Subject: Add dots at first line in docstring Running flake tests raises warning for: "First line should end with a period" Change-Id: I9714b350900500c997ef0e54e9830e232fcd6ce7 --- kolla/exception.py | 2 +- kolla/image/build.py | 16 ++++++++-------- kolla/template/methods.py | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) (limited to 'kolla') diff --git a/kolla/exception.py b/kolla/exception.py index a495ba844..4b5677db1 100644 --- a/kolla/exception.py +++ b/kolla/exception.py @@ -10,7 +10,7 @@ # See the License for the specific language governing permissions and # limitations under the License. -"""Kolla exception subclasses""" +"""Kolla exception subclasses.""" class KollaDirNotFoundException(Exception): diff --git a/kolla/image/build.py b/kolla/image/build.py index 5c171d94c..1daad392d 100755 --- a/kolla/image/build.py +++ b/kolla/image/build.py @@ -645,7 +645,7 @@ class KollaWorker(object): ) def setup_working_dir(self): - """Creates a working directory for use while building""" + """Creates a working directory for use while building.""" if self.conf.work_dir: self.working_dir = os.path.join(self.conf.work_dir, 'docker') else: @@ -673,7 +673,7 @@ class KollaWorker(object): return filters def _get_methods(self): - """Mapping of available Jinja methods + """Mapping of available Jinja methods. return a dictionary that maps available function names and their corresponding python methods to make them available in jinja templates @@ -758,7 +758,7 @@ class KollaWorker(object): return {tpl_name: tpl_content} def find_dockerfiles(self): - """Recursive search for Dockerfiles in the working directory""" + """Recursive search for Dockerfiles in the working directory.""" self.docker_build_paths = list() path = self.working_dir filename = 'Dockerfile.j2' @@ -771,12 +771,12 @@ class KollaWorker(object): LOG.debug('Found %d Dockerfiles', len(self.docker_build_paths)) def cleanup(self): - """Remove temp files""" + """Remove temp files.""" if not self.conf.work_dir: shutil.rmtree(self.temp_dir) def filter_images(self): - """Filter which images to build""" + """Filter which images to build.""" filter_ = list() if self.regex: @@ -816,7 +816,7 @@ class KollaWorker(object): image.status = STATUS_MATCHED def summary(self): - """Walk the dictionary of images statuses and print results""" + """Walk the dictionary of images statuses and print results.""" # For debug we print the logs again if the image error'd. This is to # help us debug and it will be extra helpful in the gate. for image in self.images: @@ -1025,7 +1025,7 @@ class KollaWorker(object): pprint.pprint(ancestry) def find_parents(self): - """Associate all images with parents and children""" + """Associate all images with parents and children.""" sort_images = dict() for image in self.images: @@ -1038,7 +1038,7 @@ class KollaWorker(object): image.parent = parent def build_queue(self, push_queue): - """Organizes Queue list + """Organizes Queue list. Return a list of Queues that have been organized into a hierarchy based on dependencies diff --git a/kolla/template/methods.py b/kolla/template/methods.py index 7a6ac8d64..b526aa40f 100644 --- a/kolla/template/methods.py +++ b/kolla/template/methods.py @@ -14,7 +14,7 @@ def debian_package_install(packages): - """Jinja utility method for building debian-based package install command + """Jinja utility method for building debian-based package install command. apt-get is not capable of installing .deb files from a URL and the template logic to construct a series of steps to install regular packages -- cgit v1.2.3