From 7ba8c6acc5dacfe693a3cb671fbbb58019cc0e1c Mon Sep 17 00:00:00 2001 From: Adrien Hopkins Date: Sun, 12 Nov 2023 16:04:32 -0500 Subject: Add package-level documentation --- doc.go | 5 +++++ factors/doc.go | 5 +++++ 2 files changed, 10 insertions(+) create mode 100644 doc.go create mode 100644 factors/doc.go diff --git a/doc.go b/doc.go new file mode 100644 index 0000000..a1a778f --- /dev/null +++ b/doc.go @@ -0,0 +1,5 @@ +/* +The main package contains code that outputs the result of operations +from the factors package. +*/ +package main 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 -- cgit v1.2.3