From c50ece109cdb29ab5d3fa7444040b546da7e360c Mon Sep 17 00:00:00 2001
From: Adrien Hopkins <adrien.p.hopkins@gmail.com>
Date: Mon, 9 Oct 2023 16:15:48 -0500
Subject: factors: Give all exported members proper godoc

---
 factors/factorize.go | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'factors/factorize.go')

diff --git a/factors/factorize.go b/factors/factorize.go
index 9aa43a7..16cd810 100644
--- a/factors/factorize.go
+++ b/factors/factorize.go
@@ -2,6 +2,8 @@ package factors
 
 // Factors returns a number's factors as a slice.
 // The slice is not guaranteed to be in sorted order.
+//
+// Because every number is a factor of zero, Factors(0) panics.
 func Factors(n uint) []uint {
 	if n == 0 {
 		panic("Cannot get factors of 0!")
-- 
cgit v1.2.3