updating docstrings

devsetgo · devsetgo · commit 04b04d9341d7 · 2024-05-16T17:10:12.000Z
diff --git a/coverage.xml b/coverage.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" ?>
-<coverage version="7.5.1" timestamp="1715879204939" lines-valid="682" lines-covered="198" line-rate="0.2903" branches-covered="0" branches-valid="0" branch-rate="0" complexity="0">
+<coverage version="7.5.1" timestamp="1715879394607" lines-valid="682" lines-covered="198" line-rate="0.2903" branches-covered="0" branches-valid="0" branch-rate="0" complexity="0">
 	<!-- Generated by coverage.py: https://coverage.readthedocs.io/en/7.5.1 -->
 	<!-- Based on https://raw.githubusercontent.com/cobertura/web/master/htdocs/xml/coverage-04.dtd -->
 	<sources>
diff --git a/examples/cal_example.py b/examples/cal_example.py
@@ -1,4 +1,9 @@
 # -*- coding: utf-8 -*-
+"""
+Author: Mike Ryan
+Date: 2024/05/16
+License: MIT
+"""
 from dsg_lib.common_functions import calendar_functions
 
 month_list: list = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]
diff --git a/examples/csv_example.py b/examples/csv_example.py
@@ -1,4 +1,9 @@
 # -*- coding: utf-8 -*-
+"""
+Author: Mike Ryan
+Date: 2024/05/16
+License: MIT
+"""
 from dsg_lib.common_functions.file_functions import create_sample_files, open_csv, save_csv
 from dsg_lib.common_functions.logging_config import config_log
 
diff --git a/examples/fastapi_example.py b/examples/fastapi_example.py
@@ -1,5 +1,9 @@
 # -*- coding: utf-8 -*-
-
+"""
+Author: Mike Ryan
+Date: 2024/05/16
+License: MIT
+"""
 import datetime
 import secrets
 import time
diff --git a/examples/json_example.py b/examples/json_example.py
@@ -1,4 +1,9 @@
 # -*- coding: utf-8 -*-
+"""
+Author: Mike Ryan
+Date: 2024/05/16
+License: MIT
+"""
 from dsg_lib.common_functions.file_functions import open_json, save_json
 
 example_json = {
diff --git a/examples/log_example.py b/examples/log_example.py
@@ -1,4 +1,9 @@
 # -*- coding: utf-8 -*-
+"""
+Author: Mike Ryan
+Date: 2024/05/16
+License: MIT
+"""
 import logging
 import random
 import secrets
diff --git a/examples/pattern_example.py b/examples/pattern_example.py
@@ -1,4 +1,9 @@
 # -*- coding: utf-8 -*-
+"""
+Author: Mike Ryan
+Date: 2024/05/16
+License: MIT
+"""
 import pprint
 from random import randint
 
diff --git a/examples/text_example.py b/examples/text_example.py
@@ -1,4 +1,9 @@
 # -*- coding: utf-8 -*-
+"""
+Author: Mike Ryan
+Date: 2024/05/16
+License: MIT
+"""
 from dsg_lib.common_functions.file_functions import open_text, save_text
 
 example_text = """
diff --git a/examples/validate_emails.py b/examples/validate_emails.py
@@ -33,6 +33,9 @@
     validate_email_address(email: str, **kwargs: dict) -> dict: Validates an email address using the provided
     configuration and returns a dictionary with the results.
 
+Author: Mike Ryan
+Date: 2024/05/16
+License: MIT
 """
 from dsg_lib.common_functions.email_validation import validate_email_address
 
