aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Majewsky <majewsky@gmx.net>2025-07-03 23:37:58 +0200
committerStefan Majewsky <majewsky@gmx.net>2025-07-03 23:37:58 +0200
commitd53f04ea869fb52c5d5d68a2032534bbaa27d120 (patch)
treee8bbd8f1e9ab9e4defa9da5c9e5e1450e0d4575b
parent29699af9c17c356b243ac3bed7d64260e819503f (diff)
downloadgo-gg-d53f04ea869fb52c5d5d68a2032534bbaa27d120.tar.gz
option: refer to package options in package doc
-rw-r--r--option/option.go3
1 files changed, 1 insertions, 2 deletions
diff --git a/option/option.go b/option/option.go
index 5efae9c..a96e87d 100644
--- a/option/option.go
+++ b/option/option.go
@@ -93,8 +93,7 @@
// but this restriction degrades their usefulness beyond reasonable limits.
// - Go does not allow to introduce additional type restrictions in individual methods.
// This makes methods like unzip() or cloned() unrepresentable in Go.
-// We might make these available as free-standing functions in the future, but if we do,
-// they will definitely not be in this package (see "Clean import guarantee" above).
+// We have made some of these available as free-standing functions, in "package options" that sits next to this package.
// - Mixing of struct receiver methods and pointer receiver methods on the same type is discouraged to avoid unintentional copies and data races.
// Since most of the useful methods require only a struct receiver, we forego those that require a pointer receiver, like get_or_insert() or take().
// The only exception to this is the methods implementing Unmarshaler interfaces, where concurrency bugs are very unlikely.