summaryrefslogtreecommitdiff
path: root/factors/doc.go
diff options
context:
space:
mode:
authorAdrien Hopkins <adrien.p.hopkins@gmail.com>2023-11-12 16:04:32 -0500
committerAdrien Hopkins <adrien.p.hopkins@gmail.com>2023-11-12 16:04:32 -0500
commit7ba8c6acc5dacfe693a3cb671fbbb58019cc0e1c (patch)
treedebdbe65f3e7de0182f62233de170aa5e14bb7ae /factors/doc.go
parent35374b8ff8a480b5c9a16dd12a4770b66c83b16e (diff)
Add package-level documentation
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