Fix links, mention slice & map support

Author: theory

CHANGELOG.md

@@ -26,6 +26,10 @@ All notable changes to this project will be documented in this file. It uses the
 *   Upgraded to `golangci-lint` v2.11.4 and made suggested slice allocation
     optimizations.
 
+### 📚 Documentation
+
+*   Fixed some broken Go Doc links.
+
   [v0.11.1]: https://github.com/theory/jsonpath/compare/v0.11.0...v0.11.1
   [Go blog post]: https://go.dev/blog/allocation-optimizations
     "The Go Blog: Allocating on the Stack"

README.md

@@ -4,6 +4,7 @@ RFC 9535 JSONPath in Go
 [![⚖️ MIT]][mit] [![📚 Docs]][docs] [![🗃️ Report Card]][card] [![🛠️ Build Status]][ci] [![📊 Coverage]][cov]
 
 The jsonpath package provides [RFC 9535 JSONPath] functionality in Go.
+It operates on any type of slice or string-keyed map.
 
 ## Learn More
 

path.go

@@ -1,4 +1,5 @@
 // Package jsonpath implements RFC 9535 JSONPath query expressions.
+// It operates on any type of slice or string-keyed map.
 package jsonpath
 
 import (
@@ -160,7 +161,7 @@ func (list NodeList) All() iter.Seq[any] {
 }
 
 // LocatedNodeList is a list of nodes selected by a JSONPath query, along with
-// their [NormalizedPath] locations. Returned by [Path.SelectLocated].
+// their [spec.NormalizedPath] locations. Returned by [Path.SelectLocated].
 type LocatedNodeList []*spec.LocatedNode
 
 // All returns an iterator over all the nodes in list.
@@ -188,7 +189,8 @@ func (list LocatedNodeList) Nodes() iter.Seq[any] {
 	}
 }
 
-// Paths returns an iterator over all the [NormalizedPath] values in list.
+// Paths returns an iterator over all the [spec.NormalizedPath] values in
+// list.
 func (list LocatedNodeList) Paths() iter.Seq[spec.NormalizedPath] {
 	return func(yield func(spec.NormalizedPath) bool) {
 		for _, v := range list {
@@ -199,10 +201,10 @@ func (list LocatedNodeList) Paths() iter.Seq[spec.NormalizedPath] {
 	}
 }
 
-// Deduplicate deduplicates the nodes in list based on their [NormalizedPath]
-// values, modifying the contents of list. It returns the modified list, which
-// may have a shorter length, and zeroes the elements between the new length
-// and the original length.
+// Deduplicate deduplicates the nodes in list based on their
+// [spec.NormalizedPath] values, modifying the contents of list. It returns
+// the modified list, which may have a shorter length, and zeroes the elements
+// between the new length and the original length.
 func (list LocatedNodeList) Deduplicate() LocatedNodeList {
 	if len(list) <= 1 {
 		return list
@@ -221,7 +223,7 @@ func (list LocatedNodeList) Deduplicate() LocatedNodeList {
 	return slices.Clip(uniq)
 }
 
-// Sort sorts list by the [NormalizedPath] of each node.
+// Sort sorts list by the [spec.NormalizedPath] of each node.
 func (list LocatedNodeList) Sort() {
 	slices.SortFunc(list, func(a, b *spec.LocatedNode) int {
 		return a.Path.Compare(b.Path)

registry/registry.go

@@ -46,7 +46,7 @@ func New() *Registry {
 	}
 }
 
-// ErrRegister errors are returned by [Register].
+// ErrRegister errors are returned by [Registry.Register].
 var ErrRegister = errors.New("register")
 
 // Register registers a function extension. The parameters are:

spec/function.go

@@ -46,8 +46,8 @@ type PathValue interface {
 // NodesType defines a node list (a list of JSON values) for a function
 // expression parameters or results, as defined by [RFC 9535 Section 2.4.1].
 // It can also be used in filter expressions. The underlying types should be
-// string, integer, float, [json.Number], nil, true, false, []any, or
-// map[string]any. Interfaces implemented:
+// string, integer, float, [json.Number], nil, true, false, slice, or
+// string-keyed map. Interfaces implemented:
 //
 // - [PathValue]
 // - [fmt.Stringer]
@@ -57,7 +57,7 @@ type NodesType []any
 
 // Nodes creates a NodesType that contains val, all of which should be the Go
 // equivalent of the JSON data types: string, integer, float, [json.Number],
-// nil, true, false, []any, or map[string]any.
+// nil, true, false, slice, or string-keyed map.
 func Nodes(val ...any) NodesType {
 	return NodesType(val)
 }
@@ -137,8 +137,8 @@ func (LogicalType) FuncType() FuncType { return FuncLogical }
 // LogicalFrom converts value to a [LogicalType] and panics if it cannot. Use
 // in [github.com/theory/jsonpath/registry.Registry.Register] [Evaluator]
 // functions. Avoid the panic by returning an error from the accompanying
-// [Validator] function when [FuncExprArg.ConvertsToLogical] returns false for
-// the [FuncExprArg] that returns value.
+// [Validator] function when [FuncExprArg.ConvertsTo] returns false for the
+// [FuncExprArg] that returns value.
 //
 // Converts each implementation of [PathValue] as follows:
 //   - [LogicalType]: returns value
@@ -170,7 +170,7 @@ func (lt LogicalType) writeTo(buf *strings.Builder) {
 // ValueType encapsulates a JSON value for a function expression parameter or
 // result, as defined by [RFC 9535 Section 2.4.1]. It can also be used as in
 // filter expression. The underlying value should be a string, integer,
-// [json.Number], float, nil, true, false, []any, or map[string]any. A nil
+// [json.Number], float, nil, true, false, slice, or string-keyed map. A nil
 // ValueType pointer indicates no value. Interfaces implemented:
 //
 //   - [PathValue]
@@ -184,7 +184,7 @@ type ValueType struct {
 
 // Value returns a new [ValueType] for val, which must be the Go equivalent of
 // a JSON data type: string, integer, float, [json.Number], nil, true, false,
-// []any, or map[string]any.
+// slice, or string-keyed map.
 func Value(val any) *ValueType {
 	return &ValueType{val}
 }
@@ -201,8 +201,8 @@ func (*ValueType) FuncType() FuncType { return FuncValue }
 // ValueFrom converts value to a [ValueType] and panics if it cannot. Use in
 // [github.com/theory/jsonpath/registry.Registry.Register] [Evaluator]
 // functions. Avoid the panic by returning an error from the accompanying
-// [Validator] function when [FuncExprArg.ConvertsToValue] returns false for
-// the [FuncExprArg] that returns value.
+// [Validator] function when [FuncExprArg.ConvertsTo] returns false for the
+// [FuncExprArg] that returns value.
 //
 // Converts each implementation of [PathValue] as follows:
 //   - [ValueType]: returns value