aboutsummaryrefslogtreecommitdiff
path: root/src/pds.go
diff options
context:
space:
mode:
authorEuAndreh <eu@euandre.org>2025-05-19 05:17:59 -0300
committerEuAndreh <eu@euandre.org>2025-05-19 05:17:59 -0300
commit81f6ff87990f318a565d9624d6272c67e811d220 (patch)
tree2fc0f0e79285c74f62e6f37c9e5851d85f9124a8 /src/pds.go
parenttests/fuzz/vector/pds.go: Implement first model for others to be made equivalent (diff)
downloadpds-81f6ff87990f318a565d9624d6272c67e811d220.tar.gz
pds-81f6ff87990f318a565d9624d6272c67e811d220.tar.xz
src/pds.go: Add leading slash on package comment
Diffstat (limited to 'src/pds.go')
-rw-r--r--src/pds.go82
1 files changed, 41 insertions, 41 deletions
diff --git a/src/pds.go b/src/pds.go
index 9d14648..7eecfa5 100644
--- a/src/pds.go
+++ b/src/pds.go
@@ -1,44 +1,44 @@
-// Package immutable provides immutable collection types.
-//
-// # Introduction
-//
-// Immutable collections provide an efficient, safe way to share collections
-// of data while minimizing locks. The collections in this package provide
-// Vector, Map, and SortedMap implementations. These act similarly to slices
-// and maps, respectively, except that altering a collection returns a new
-// copy of the collection with that change.
-//
-// Because collections are unable to change, they are safe for multiple
-// goroutines to read from at the same time without a mutex. However, these
-// types of collections come with increased CPU & memory usage as compared
-// with Go's built-in collection types so please evaluate for your specific
-// use.
-//
-// # Collection Types
-//
-// The Vector type provides an API similar to Go slices. They allow appending,
-// prepending, and updating of elements. Elements can also be fetched by index
-// or iterated over using a VectorIterator.
-//
-// The Map & SortedMap types provide an API similar to Go maps. They allow
-// values to be assigned to unique keys and allow for the deletion of keys.
-// Values can be fetched by key and key/value pairs can be iterated over using
-// the appropriate iterator type. Both map types provide the same API. The
-// SortedMap, however, provides iteration over sorted keys while the Map
-// provides iteration over unsorted keys. Maps improved performance and memory
-// usage as compared to SortedMaps.
-//
-// # Hashing and Sorting
-//
-// Map types require the use of a Hasher implementation to calculate hashes for
-// their keys and check for key equality. SortedMaps require the use of a
-// Comparer implementation to sort keys in the map.
-//
-// These collection types automatically provide built-in hasher and comparers
-// for int, string, and byte slice keys. If you are using one of these key types
-// then simply pass a nil into the constructor. Otherwise you will need to
-// implement a custom Hasher or Comparer type. Please see the provided
-// implementations for reference.
+/// Package immutable provides immutable collection types.
+///
+/// == Introduction
+///
+/// Immutable collections provide an efficient, safe way to share collections
+/// of data while minimizing locks. The collections in this package provide
+/// Vector, Map, and SortedMap implementations. These act similarly to slices
+/// and maps, respectively, except that altering a collection returns a new
+/// copy of the collection with that change.
+///
+/// Because collections are unable to change, they are safe for multiple
+/// goroutines to read from at the same time without a mutex. However, these
+/// types of collections come with increased CPU & memory usage as compared
+/// with Go's built-in collection types so please evaluate for your specific
+/// use.
+///
+/// == Collection Types
+///
+/// The Vector type provides an API similar to Go slices. They allow appending,
+/// prepending, and updating of elements. Elements can also be fetched by index
+/// or iterated over using a VectorIterator.
+///
+/// The Map & SortedMap types provide an API similar to Go maps. They allow
+/// values to be assigned to unique keys and allow for the deletion of keys.
+/// Values can be fetched by key and key/value pairs can be iterated over using
+/// the appropriate iterator type. Both map types provide the same API. The
+/// SortedMap, however, provides iteration over sorted keys while the Map
+/// provides iteration over unsorted keys. Maps improved performance and memory
+/// usage as compared to SortedMaps.
+///
+/// == Hashing and Sorting
+///
+/// Map types require the use of a Hasher implementation to calculate hashes for
+/// their keys and check for key equality. SortedMaps require the use of a
+/// Comparer implementation to sort keys in the map.
+///
+/// These collection types automatically provide built-in hasher and comparers
+/// for int, string, and byte slice keys. If you are using one of these key types
+/// then simply pass a nil into the constructor. Otherwise you will need to
+/// implement a custom Hasher or Comparer type. Please see the provided
+/// implementations for reference.
package pds
import (