Make functional option functions return a function

Author: oschwald

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changes
 
+## 2.0.0-beta.4
+
+- `IncludeNetworksWithoutData` and `IncludeAliasedNetworks` now return a
+  `NetworksOption` rather than being one themselves. This was done to improve
+  the documentation organization.
+
 ## 2.0.0-beta.3 - 2025-02-16
 
 - `Open` will now fall back to loading the database in memory if the

traverse.go

@@ -32,14 +32,18 @@ type NetworksOption func(*networkOptions)
 // IncludeAliasedNetworks is an option for Networks and NetworksWithin
 // that makes them iterate over aliases of the IPv4 subtree in an IPv6
 // database, e.g., ::ffff:0:0/96, 2001::/32, and 2002::/16.
-func IncludeAliasedNetworks(networks *networkOptions) {
-	networks.includeAliasedNetworks = true
+func IncludeAliasedNetworks() NetworksOption {
+	return func(networks *networkOptions) {
+		networks.includeAliasedNetworks = true
+	}
 }
 
 // IncludeNetworksWithoutData is an option for Networks and NetworksWithin
 // that makes them include networks without any data in the iteration.
-func IncludeNetworksWithoutData(networks *networkOptions) {
-	networks.includeEmptyNetworks = true
+func IncludeNetworksWithoutData() NetworksOption {
+	return func(networks *networkOptions) {
+		networks.includeEmptyNetworks = true
+	}
 }
 
 // Networks returns an iterator that can be used to traverse the networks in

traverse_test.go

@@ -227,7 +227,7 @@ var tests = []networkTest{
 			"2002:101:110::/44",
 			"2002:101:120::/48",
 		},
-		Options: []NetworksOption{IncludeAliasedNetworks},
+		Options: []NetworksOption{IncludeAliasedNetworks()},
 	},
 	{
 		Network:  "::/0",
@@ -281,7 +281,7 @@ var tests = []networkTest{
 			"1.64.0.0/10",
 			"1.128.0.0/9",
 		},
-		Options: []NetworksOption{IncludeNetworksWithoutData},
+		Options: []NetworksOption{IncludeNetworksWithoutData()},
 	},
 	{
 		Network:  "1.1.1.16/28",