summaryrefslogtreecommitdiff
path: root/factors/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'factors/doc.go')
-rw-r--r--factors/doc.go5
1 files changed, 5 insertions, 0 deletions
diff --git a/factors/doc.go b/factors/doc.go
new file mode 100644
index 0000000..1b4dc02
--- /dev/null
+++ b/factors/doc.go
@@ -0,0 +1,5 @@
+/*
+The factors package contains all of the functions that compute the scores
+and ranks of radix_info, as well as all of the number theory behind them.
+*/
+package factors