Add purpose to file headers

MythTV · Aug 6, 2021 · b763179 · b763179
1 parent 4fb58c3
commit b763179
Show file tree

Hide file tree

Showing 9 changed files with 50 additions and 5 deletions.
diff --git a/mythtv/bindings/python/ttvdbv4/definitions.py b/mythtv/bindings/python/ttvdbv4/definitions.py
@@ -1,5 +1,11 @@
 # -*- coding: UTF-8 -*-
 
+# ---------------------------------------
+# Author:  Roland Ernst
+# Purpose: MythTV Bindings for TheTVDB v4
+# ---------------------------------------
+
+
 def _get_list(item, name):
     l = []
     if item is not None:

diff --git a/mythtv/bindings/python/ttvdbv4/get_api_v4.py b/mythtv/bindings/python/ttvdbv4/get_api_v4.py
@@ -1,5 +1,16 @@
 # -*- coding: UTF-8 -*-
 
+# ---------------------------------------
+# Author:  Roland Ernst
+# Purpose: MythTV Bindings for TheTVDB v4
+# ---------------------------------------
+
+# Purpose:
+#   Parse openapi specification for ttvdb v 4 .
+#   Create definitions and api for the files
+#     - definitions.py
+#     - ttvdbv4_api.py
+
 
 import sys
 import os

diff --git a/mythtv/bindings/python/ttvdbv4/locales.py b/mythtv/bindings/python/ttvdbv4/locales.py
@@ -4,7 +4,7 @@
 # Python Library
 # Author: Raymond Wagner
 #-----------------------
-# Name: Roland Ernst
+# Author: Roland Ernst
 # Modifications:
 #   - Added ISO931-2T/2B
 #   - Added ISO-3166 alpha-3

diff --git a/mythtv/bindings/python/ttvdbv4/myth4ttvdbv4.py b/mythtv/bindings/python/ttvdbv4/myth4ttvdbv4.py
@@ -1,9 +1,10 @@
 # -*- coding: UTF-8 -*-
 
-# --------------------------------------
-# Author: Roland Ernst
-# Name: MythTV Bindings for TheTVDB v4
-# --------------------------------------
+# ---------------------------------------
+# Author:  Roland Ernst
+# Purpose: MythTV Bindings for TheTVDB v4
+# ---------------------------------------
+
 
 import sys
 import json

diff --git a/mythtv/bindings/python/ttvdbv4/ttvdbv4_api.py b/mythtv/bindings/python/ttvdbv4/ttvdbv4_api.py
@@ -1,5 +1,11 @@
 # -*- coding: UTF-8 -*-
 
+# ---------------------------------------
+# Author:  Roland Ernst
+# Purpose: MythTV Bindings for TheTVDB v4
+# ---------------------------------------
+
+
 import sys
 from requests import codes as requestcodes
 from urllib.parse import urlencode, quote_plus, quote

diff --git a/mythtv/bindings/python/ttvdbv4/utils.py b/mythtv/bindings/python/ttvdbv4/utils.py
@@ -1,5 +1,11 @@
 # -*- coding: UTF-8 -*-
 
+# ---------------------------------------
+# Author:  Roland Ernst
+# Purpose: MythTV Bindings for TheTVDB v4
+# ---------------------------------------
+
+
 from datetime import datetime
 import sys
 

diff --git a/mythtv/programs/scripts/metadata/Television/ttvdb4.ini b/mythtv/programs/scripts/metadata/Television/ttvdb4.ini
@@ -1,5 +1,10 @@
 # -*- coding: UTF-8 -*-
 
+# ---------------------------------------
+# Author:  Roland Ernst
+# Purpose: MythTV Bindings for TheTVDB v4
+# ---------------------------------------
+
 # MythTV's television grabber 'ttvdb4.py':
 # User modifiable configuration
 # Hints:

diff --git a/mythtv/programs/scripts/metadata/Television/ttvdb4.py b/mythtv/programs/scripts/metadata/Television/ttvdb4.py
@@ -1,6 +1,12 @@
 #!/usr/bin/env python3
 # -*- coding: UTF-8 -*-
 
+# ---------------------------------------
+# Author:  Roland Ernst
+# Purpose: MythTV Bindings for TheTVDB v4
+# ---------------------------------------
+
+
 import argparse
 import sys
 import os

diff --git a/mythtv/programs/scripts/metadata/Television/ttvdb4_doctests b/mythtv/programs/scripts/metadata/Television/ttvdb4_doctests
@@ -1,5 +1,9 @@
 # -*- coding: UTF-8 -*-
 
+# ---------------------------------------
+# Author:  Roland Ernst
+# Purpose: MythTV Bindings for TheTVDB v4
+# ---------------------------------------
 
 # Doc-Tests for ttvdb4
 # file: ttvdb4_doctests