Document output format

kgryte · kgryte · commit ebec86f45c4d · 2016-10-21T02:46:11.000-07:00
diff --git a/tools/git/scripts/commits_per_hour b/tools/git/scripts/commits_per_hour
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of commits per hour.
+#
+# <hour> <num_commits>
 
 # * `git log`
 #   - Show commit logs.
diff --git a/tools/git/scripts/commits_per_month b/tools/git/scripts/commits_per_month
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of commits per month.
+#
+# <month> <year> <num_commits>
 
 # * `git log`
 #   - Show commit logs.
diff --git a/tools/git/scripts/commits_per_weekday b/tools/git/scripts/commits_per_weekday
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of commits per weekday.
+#
+# <weekday> <num_commits>
 
 # * `git log`
 #   - Show commit logs.
diff --git a/tools/git/scripts/commits_per_year b/tools/git/scripts/commits_per_year
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of commits per year.
+#
+# <year> <num_commits>
 
 # * `git log`
 #   - Show commit logs.
diff --git a/tools/git/scripts/deletions_per_day b/tools/git/scripts/deletions_per_day
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of deletions per day.
+#
+# <month> <day> <year> <deletions>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/deletions_per_hour b/tools/git/scripts/deletions_per_hour
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of deletions per hour.
+#
+# <hour> <deletions>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/deletions_per_month b/tools/git/scripts/deletions_per_month
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of deletions per month.
+#
+# <month> <year> <deletions>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/deletions_per_weekday b/tools/git/scripts/deletions_per_weekday
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of deletions per weekday.
+#
+# <weekday> <deletions>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/files_changed_per_day b/tools/git/scripts/files_changed_per_day
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of changed files per day.
+#
+# <month> <day> <year> <files_changed>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/files_changed_per_hour b/tools/git/scripts/files_changed_per_hour
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of files changed per hour.
+#
+# <hour> <files_changed>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/files_changed_per_month b/tools/git/scripts/files_changed_per_month
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of files changed per month.
+#
+# <month> <year> <files_changed>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/files_changed_per_weekday b/tools/git/scripts/files_changed_per_weekday
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of files changed per weekday.
+#
+# <weekday> <files_changed>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/mean_additions_per_hour b/tools/git/scripts/mean_additions_per_hour
@@ -2,6 +2,8 @@
 #
 # Prints the average number of additions per hour.
 #
+# <hour> <avg_additions>
+#
 # Algorithm:
 #
 # * Determine the total number of additions that have occurred during each hour.
diff --git a/tools/git/scripts/mean_commit_message_length_per_hour b/tools/git/scripts/mean_commit_message_length_per_hour
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the average commit message length per hour.
+#
+# <hour> <avg_length>
 
 # * `git log`
 #   - Print commit messages.
diff --git a/tools/git/scripts/mean_commits_per_hour b/tools/git/scripts/mean_commits_per_hour
@@ -2,6 +2,8 @@
 #
 # Prints the average number of commits per hour.
 #
+# <hour> <avg_num_commits>
+#
 # Algorithm:
 #
 # * Determine the total number of commits that have occurred during each hour.
diff --git a/tools/git/scripts/mean_deletions_per_hour b/tools/git/scripts/mean_deletions_per_hour
@@ -2,6 +2,8 @@
 #
 # Prints the average number of deletions per hour.
 #
+# <hour> <avg_deletions>
+#
 # Algorithm:
 #
 # * Determine the total number of deletions that have occurred during each hour.
diff --git a/tools/git/scripts/mean_files_changed_per_hour b/tools/git/scripts/mean_files_changed_per_hour
@@ -2,6 +2,8 @@
 #
 # Prints the average number of files changed per hour.
 #
+# <hour> <avg_files_changed>
+#
 # Algorithm:
 #
 # * Determine the total number of files changed that have occurred during each hour.

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`#!/usr/bin/env bash`
`2`	`2`	`#`
`3`	`3`	`# Prints the number of commits per hour.`
	`4`	`+#`
	`5`	`+# <hour> <num_commits>`
`4`	`6`
`5`	`7`	# * `git log`
`6`	`8`	`# - Show commit logs.`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`#!/usr/bin/env bash`
`2`	`2`	`#`
`3`	`3`	`# Prints the number of commits per month.`
	`4`	`+#`
	`5`	`+# <month> <year> <num_commits>`
`4`	`6`
`5`	`7`	# * `git log`
`6`	`8`	`# - Show commit logs.`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`#!/usr/bin/env bash`
`2`	`2`	`#`
`3`	`3`	`# Prints the number of commits per weekday.`
	`4`	`+#`
	`5`	`+# <weekday> <num_commits>`
`4`	`6`
`5`	`7`	# * `git log`
`6`	`8`	`# - Show commit logs.`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`#!/usr/bin/env bash`
`2`	`2`	`#`
`3`	`3`	`# Prints the number of commits per year.`
	`4`	`+#`
	`5`	`+# <year> <num_commits>`
`4`	`6`
`5`	`7`	# * `git log`
`6`	`8`	`# - Show commit logs.`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`#!/usr/bin/env bash`
`2`	`2`	`#`
`3`	`3`	`# Prints the number of deletions per day.`
	`4`	`+#`
	`5`	`+# <month> <day> <year> <deletions>`
`4`	`6`
`5`	`7`	`# Determine root directory:`
`6`	`8`	`root="$(git rev-parse --show-toplevel)"`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`#!/usr/bin/env bash`
`2`	`2`	`#`
`3`	`3`	`# Prints the number of deletions per hour.`
	`4`	`+#`
	`5`	`+# <hour> <deletions>`
`4`	`6`
`5`	`7`	`# Determine root directory:`
`6`	`8`	`root="$(git rev-parse --show-toplevel)"`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`#!/usr/bin/env bash`
`2`	`2`	`#`
`3`	`3`	`# Prints the number of deletions per month.`
	`4`	`+#`
	`5`	`+# <month> <year> <deletions>`
`4`	`6`
`5`	`7`	`# Determine root directory:`
`6`	`8`	`root="$(git rev-parse --show-toplevel)"`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`#!/usr/bin/env bash`
`2`	`2`	`#`
`3`	`3`	`# Prints the number of deletions per weekday.`
	`4`	`+#`
	`5`	`+# <weekday> <deletions>`
`4`	`6`
`5`	`7`	`# Determine root directory:`
`6`	`8`	`root="$(git rev-parse --show-toplevel)"`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`#!/usr/bin/env bash`
`2`	`2`	`#`
`3`	`3`	`# Prints the number of changed files per day.`
	`4`	`+#`
	`5`	`+# <month> <day> <year> <files_changed>`
`4`	`6`
`5`	`7`	`# Determine root directory:`
`6`	`8`	`root="$(git rev-parse --show-toplevel)"`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`#!/usr/bin/env bash`
`2`	`2`	`#`
`3`	`3`	`# Prints the number of files changed per hour.`
	`4`	`+#`
	`5`	`+# <hour> <files_changed>`
`4`	`6`
`5`	`7`	`# Determine root directory:`
`6`	`8`	`root="$(git rev-parse --show-toplevel)"`