improve docs, remove one comment

Author: adomani

.github/workflows/monthly_pr_report.yaml

@@ -33,7 +33,6 @@ jobs:
         run: |
           yrMth=2024-07
           mth="$(date -d "${yrMth}-01" '+%B')"
-          #PR="${{ github.event.pull_request.number }}"
           title="### ${mth} in Mathlib summary"
 
           mim="$(printf '%s\n\n%s\n' "${title}" "$(cd mathlib; ./../blog/monthly_summary.sh "${yrMth}")")"

monthly_summary.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-# Check if required arguments are provided
+# Check if required argument is provided
 if [ "$#" -ne 1 ]; then
     printf $'Usage: %s <YYYY-MM>\n\nFor instance `%s 2024-07`\n\n' "${0}" "${0}"
     exit 1
@@ -16,15 +16,12 @@ repository='leanprover-community/mathlib4'
 startDate="${1}"
 endDate="${2}"
 
-# find how many commits to master there have been in the last month
+# find how many commits to master there have been in the given range -- note that there is a limit to how many commits `gh` returns
 commits_in_range="$(git log --since="${startDate}" --until="${endDate}" --pretty=oneline | wc -l)"
 
-# Retrieve merged PRs from the given range
+# Retrieve merged (i.e. closed, due to bors) PRs from the given range
 prs=$(gh pr list --repo "$repository" --state closed --base master --search "closed:${startDate}..${endDate}" --json number,labels,title,author --limit "$((commits_in_range * 2))")
 
-## Print PR numbers, their labels and their title
-#echo "$prs" | jq -r '.[] | select(.title | startswith("[Merged by Bors]")) | "PR #\(.number) - Labels: \((.labels | map(.name) | join(", ")) // "No labels") - Title: \(.title)"'
-
 # Store to file `found_by_gh.txt` the PR numbers, as found by `gh`
 echo "$prs" | jq -r '.[] | select(.title | startswith("[Merged by Bors]")) | "(#\(.number))"' | sort >> found_by_gh.txt
 
@@ -35,7 +32,7 @@ git log --pretty=oneline --since="${startDate}" --until="${endDate}" |
 echo "$prs"
 }
 
-# the current year and month
+# the year and month being processed
 yr_mth="${1}" #"$(date +%Y-%m)"
 yr_mth_day=${yr_mth}-01
 
@@ -52,9 +49,6 @@ printf $'\n\nBetween %s and %s there were\n' "${yr_mth_day}" "${end_date/%T*}"
 
 printf $'* %s commits to `master` and\n' "${commits_in_range}"
 
-#echo "First run:  ${start_date} ${yr_mth}-15T23:59:59"
-#echo "Second run: ${yr_mth}-16T00:00:00 ${end_date}"
-
 (
 findInRange "${start_date}" "${yr_mth}-15T23:59:59" | sed -z 's=]\n*$=,\n='
 findInRange "${yr_mth}-16T00:00:00" "${end_date}"   | sed -z 's=^\[=='