summaryrefslogtreecommitdiff
path: root/factors/factorize.go
diff options
context:
space:
mode:
authorAdrien Hopkins <adrien.p.hopkins@gmail.com>2023-10-09 16:15:48 -0500
committerAdrien Hopkins <adrien.p.hopkins@gmail.com>2023-10-09 16:16:29 -0500
commitc50ece109cdb29ab5d3fa7444040b546da7e360c (patch)
tree33fbf5678f2030a85f6c4b4f20ff5fc302516c53 /factors/factorize.go
parentdbd02c8437ae634f4ece3c2979afeb19a3979f61 (diff)
factors: Give all exported members proper godoc
Diffstat (limited to 'factors/factorize.go')
-rw-r--r--factors/factorize.go2
1 files changed, 2 insertions, 0 deletions
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!")