Browse Source

Add dots at first line in docstring

Running flake tests raises warning for:
"First line should end with a period"

Change-Id: I9714b350900500c997ef0e54e9830e232fcd6ce7
changes/33/462433/1
Eduardo Gonzalez 4 years ago
parent
commit
521e536416
  1. 2
      kolla/exception.py
  2. 16
      kolla/image/build.py
  3. 2
      kolla/template/methods.py

2
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):

16
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

2
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

Loading…
Cancel
Save