[awk-edits] Updated documentation of multiple scripts

4 files changed, 16 insertions, 10 deletions

diff --git a/awk-edits/Flags.awk b/awk-edits/Flags.awk
index 928b586..c2b4ec5 100644
--- a/awk-edits/Flags.awk
+++ b/awk-edits/Flags.awk
@@ -2,12 +2,13 @@
 # == About ==
 #
 # A collection of ftags that generate an image HTML tag, containing the specified
-# flag. This is done, because these tags need to have the unzoomable class, which
-# you can't specify in Markdown.
+# flag. This is done, because these tags need to have specific classes, which is
+# supported in Markdown, but is less flexible and more tedious.
 
 # == ftags ==
 #
 # &&gb    Great Britain flag
+# &&bg    Bulgarian flag
 #
 # -- Placement/Flow --
 #
diff --git a/awk-edits/Group-contents.awk b/awk-edits/Group-contents.awk
index d984eef..7f930b6 100644
--- a/awk-edits/Group-contents.awk
+++ b/awk-edits/Group-contents.awk
@@ -1,9 +1,12 @@
 #
 # == About ==
-# 
-# This script surrounds the "Contents" heading, as well as the list itself, in a div wrapper element
-# For it to work properly, the contents heading must be h2 and have it's id as "contents",
-# and there must be a paragraph element after the item list
+#
+# Some pages contain contents info, comprised of a "Contents" heading (h2) and a
+# (usually ordered) list of anchors to headings in the current page.
+# This script groups that heading and list into a wrapper element with id
+# "contents-container", which can then be handled more specifically.
+#
+# In my case, the contents appear on the right of remaining text.
 
 BEGIN {
 	started = 0
diff --git a/awk-edits/Header-description.awk b/awk-edits/Header-description.awk
index 028c14c..1822b88 100644
--- a/awk-edits/Header-description.awk
+++ b/awk-edits/Header-description.awk
@@ -1,8 +1,8 @@
 #
 # == About ==
 #
-# Every page has a description and og:description meta tags. These descriptions
-# are generated from the paragraphs, inside the given page.
+# Every page has a description and og:description meta tags. These descriptions are
+# generated from the text inside paragraphs of the current page.
 # The value for those meta tags is "[DESCRIPTION]" and it gets replaced with
 # either all of the text on the page, or only the first 200 characters.
 
diff --git a/awk-edits/Pagenav.awk b/awk-edits/Pagenav.awk
index ddf74ff..2971dd7 100644
--- a/awk-edits/Pagenav.awk
+++ b/awk-edits/Pagenav.awk
@@ -5,11 +5,13 @@
 # and GitLab source link.
 # Currently it only works for blog and tutorial pages.
 #
-# This is by far the most hard-coded and inefficient awk script in the generate-hooks.
+# This is by far the most hard-coded and inefficient awk script in awk-edits.
 # Creation and last edited dates are taken from git commits, and getting the correct info
-# by file name can easily only be done with git log, which unfortunately is very slow.
+# by file name can only be done (easily) with git log, which is unfortunately very slow.
 # Another issue is that it depends on the build directories in build scripts, meaning
 # it won't work without modification if you try to build it somewhere else.
+#
+# Split into Pagenav.awk and post-pagenav.awk
 
 BEGIN {
 	fileCheck = ARGV[1] # FILENAME isn't available in BEGIN