From 40acaa0b13f05672283af2ae9432e47d26f46ef1 Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Wed, 10 Apr 2019 14:50:48 +0200 Subject: [PATCH] add some missing docstrings --- ansiblelater/command/__init__.py | 1 + ansiblelater/rules/__init__.py | 1 + ansiblelater/rules/ansiblefiles.py | 2 ++ ansiblelater/rules/rolefiles.py | 2 ++ ansiblelater/rules/yamlfiles.py | 2 ++ ansiblelater/utils/__init__.py | 2 ++ ansiblelater/utils/rulehelper.py | 2 ++ ansiblelater/utils/yamlhelper.py | 2 ++ 8 files changed, 14 insertions(+) diff --git a/ansiblelater/command/__init__.py b/ansiblelater/command/__init__.py index e69de29..4ede8e6 100644 --- a/ansiblelater/command/__init__.py +++ b/ansiblelater/command/__init__.py @@ -0,0 +1 @@ +# noqa diff --git a/ansiblelater/rules/__init__.py b/ansiblelater/rules/__init__.py index e69de29..4ede8e6 100644 --- a/ansiblelater/rules/__init__.py +++ b/ansiblelater/rules/__init__.py @@ -0,0 +1 @@ +# noqa diff --git a/ansiblelater/rules/ansiblefiles.py b/ansiblelater/rules/ansiblefiles.py index 53f420a..5524266 100644 --- a/ansiblelater/rules/ansiblefiles.py +++ b/ansiblelater/rules/ansiblefiles.py @@ -1,3 +1,5 @@ +"""Checks related to ansible specific best practices.""" + import os import re from collections import defaultdict diff --git a/ansiblelater/rules/rolefiles.py b/ansiblelater/rules/rolefiles.py index 350ee34..a2a8df0 100644 --- a/ansiblelater/rules/rolefiles.py +++ b/ansiblelater/rules/rolefiles.py @@ -1,3 +1,5 @@ +"""Checks related to ansible roles files.""" + from nested_lookup import nested_lookup from ansiblelater.command.candidates import Error, Result diff --git a/ansiblelater/rules/yamlfiles.py b/ansiblelater/rules/yamlfiles.py index 6b0c4e4..ce3171f 100644 --- a/ansiblelater/rules/yamlfiles.py +++ b/ansiblelater/rules/yamlfiles.py @@ -1,3 +1,5 @@ +"""Checks related to generic YAML syntax (yamllint).""" + import codecs import os diff --git a/ansiblelater/utils/__init__.py b/ansiblelater/utils/__init__.py index 2a6a599..e3999a7 100644 --- a/ansiblelater/utils/__init__.py +++ b/ansiblelater/utils/__init__.py @@ -1,3 +1,5 @@ +"""Global utils collection.""" + from __future__ import print_function import contextlib diff --git a/ansiblelater/utils/rulehelper.py b/ansiblelater/utils/rulehelper.py index d1c0da8..8fc306c 100644 --- a/ansiblelater/utils/rulehelper.py +++ b/ansiblelater/utils/rulehelper.py @@ -1,3 +1,5 @@ +"""Abstracted methods to simplify role writeup.""" + import codecs from collections import defaultdict diff --git a/ansiblelater/utils/yamlhelper.py b/ansiblelater/utils/yamlhelper.py index a4aa42e..d4ea634 100644 --- a/ansiblelater/utils/yamlhelper.py +++ b/ansiblelater/utils/yamlhelper.py @@ -1,3 +1,5 @@ +"""Utils for YAML file operations.""" + # Copyright (c) 2013-2014 Will Thames # # Permission is hereby granted, free of charge, to any person obtaining a copy