fix doc string

MacHu-GWU · Jun 29, 2021 · 2989566 · 2989566
1 parent 0e657ba
commit 2989566
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 6 deletions.
diff --git a/cottonformation/core/env.py b/cottonformation/core/env.py
@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 """
-AWS Environment
+AWS Environment and Deployment component.
 """
 
 import hashlib

diff --git a/cottonformation/core/helpers/awslambda.py b/cottonformation/core/helpers/awslambda.py
@@ -2,6 +2,8 @@
 
 class LambdaRuntime:
     """
+    Aws Lambda related constant helpers.
+
     This data is based on https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html
     """
     nodejs14 = "nodejs14.x"

diff --git a/cottonformation/core/model.py b/cottonformation/core/model.py
@@ -1,5 +1,9 @@
 # -*- coding: utf-8 -*-
 
+"""
+This module implements the AWS Object used in CloudFormation template.
+"""
+
 import typing
 from collections import OrderedDict
 import attr

diff --git a/cottonformation/core/tagging.py b/cottonformation/core/tagging.py
diff --git a/cottonformation/core/template.py b/cottonformation/core/template.py
@@ -1,5 +1,10 @@
 # -*- coding: utf-8 -*-
 
+"""
+This module implements the core component CloudFormation Template. Many
+black magic features are provided.
+"""
+
 import json
 import attr
 import typing