Add note about difference from reference implementation

kgryte · kgryte · commit 4f70e6413bf0 · 2016-10-20T13:52:32.000-07:00
diff --git a/tools/git/scripts/commit_sizes b/tools/git/scripts/commit_sizes
@@ -2,6 +2,10 @@
 #
 # Computes a commit size.
 #
+# Notes:
+#
+# * This is not an exact implementation of the measure described by Riehle, et al. Notably, here, the size may include empty lines, which are explicitly omitted in their measure.
+#
 # References:
 #
 # * Riehle, Dirk, Carsten Kolassa, and Michel A. Salim. 2012. "Developer Belief vs. Reality: The Case of the Commit Size Distribution." *Software Engineering 2012, GI-Edition Lecture Notes in Informatics* abs/1408.4644: 59–70. <http://arxiv.org/abs/1408.4644>.

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,10 @@`
`2`	`2`	`#`
`3`	`3`	`# Computes a commit size.`
`4`	`4`	`#`
	`5`	`+# Notes:`
	`6`	`+#`
	`7`	`+# * This is not an exact implementation of the measure described by Riehle, et al. Notably, here, the size may include empty lines, which are explicitly omitted in their measure.`
	`8`	`+#`
`5`	`9`	`# References:`
`6`	`10`	`#`
`7`	`11`	`# * Riehle, Dirk, Carsten Kolassa, and Michel A. Salim. 2012. "Developer Belief vs. Reality: The Case of the Commit Size Distribution." Software Engineering 2012, GI-Edition Lecture Notes in Informatics abs/1408.4644: 59–70. <http://arxiv.org/abs/1408.4644>.`