comment cleanup

amprolla_init.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-# see LICENSE file for copyright and license details
+# See LICENSE file for copyright and license details.
 
 """
 This module will download the initial Release files used to populate

amprolla_merge.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-# see LICENSE file for copyright and license details
+# See LICENSE file for copyright and license details.
 
 """
 Amprolla main module

amprolla_merge_contents.py

@@ -1,4 +1,6 @@
 #!/usr/bin/env python3
+# See LICENSE file for copyright and license details.
+
 """
 Amprolla module for merging Contents files
 """

contrib/populate_aliases.sh

@@ -1,6 +1,8 @@
 #!/bin/sh
-# helper script to be ran once after the initial mass merge in order
-# to populate the structure with the needed symlinks
+# See LICENSE file for copyright and license details.
+
+# Helper script to be ran once after the initial mass merge in
+# order to populate the structure with the needed symlinks.
 
 dryrun=""
 [ "$1" = "-d" ] && dryrun="echo"

lib/config.def.py

@@ -1,4 +1,4 @@
-# see LICENSE file for copyright and license details
+# See LICENSE file for copyright and license details.
 
 """
 amprolla configuration file

lib/globalvars.py

@@ -1,4 +1,4 @@
-# see LICENSE file for copyright and license details
+# See LICENSE file for copyright and license details.
 
 """
 amprolla globals to pass around

lib/log.py

@@ -1,4 +1,4 @@
-# see LICENSE file for copyright and license details
+# See LICENSE file for copyright and license details.
 
 """
 Logging functions

lib/net.py

@@ -1,4 +1,4 @@
-# see LICENSE file for copyright and license details
+# See LICENSE file for copyright and license details.
 
 """
 Network functions/helpers

lib/package.py

@@ -1,4 +1,4 @@
-# see LICENSE file for copyright and license details
+# See LICENSE file for copyright and license details.
 
 """
 Package merging functions and helpers
@@ -62,7 +62,8 @@ def write_packages(packages, filename, sort=True, sources=False):
 
 
 def load_packages_file(filename):
-    """ Load a gzip'd packages file.
+    """
+    Load a gzip'd packages file.
     Returns a dictionary of package name and package key-values.
     """
     # TODO: should we skip files like this if they don't exist?

lib/parse.py

@@ -1,4 +1,4 @@
-# see LICENSE file for copyright and license details
+# See LICENSE file for copyright and license details.
 
 """
 Parsing functions/helpers
@@ -49,7 +49,9 @@ def parse_release(reltext):
 
 
 def parse_release_head(reltext):
-    """Parses the header of the release file to grab needed metadata"""
+    """
+    Parses the header of the release file to grab needed metadata
+    """
     metadata = {}
 
     contents = reltext.split('\n')
@@ -69,7 +71,9 @@ def parse_release_head(reltext):
 
 
 def parse_package(entry):
-    """ Parses a single Packages entry """
+    """
+    Parses a single Packages entry
+    """
     pkgs = {}
 
     contents = entry.split('\n')

lib/release.py

@@ -1,4 +1,4 @@
-# see LICENSE file for copyright and license details
+# See LICENSE file for copyright and license details.
 
 """
 Release file functions and helpers

orchestrate.sh

@@ -1,15 +1,17 @@
 #!/bin/sh
-# orchestration of incremental updates
+# See LICENSE file for copyright and license details.
 
-# make sure these correlate to lib/config.py
+# Orchestration of incremental updates
+
+# Make sure these correlate to lib/config.py
 AMPROLLA_UPDATE=/srv/amprolla/amprolla_update.py
 REPO_ROOT=/srv/amprolla
 
-# TODO: remove the while loop and run with cron after testing phase
+# TODO: Remove the while loop and run with cron after testing phase
 
 while true; do
 	ln -snf "$REPO_ROOT"/merged-staging "$REPO_ROOT"/merged
-	# the break call is temporary to catch unhandled exceptions in the testing phase
+	# The break call is temporary to catch unhandled exceptions in the testing phase
 	python3 "$AMPROLLA_UPDATE" || {
 		ln -snf "$REPO_ROOT"/merged-production "$REPO_ROOT"/merged
 		break