Documentation, issue #45.

ext/array/array.go

@@ -12,8 +12,9 @@ import (
 )
 
 // Register registers the array single-argument, table-valued SQL function.
-// The argument must be an [sqlite3.Pointer] to a Go slice or array
-// of ints, floats, bools, strings or blobs.
+// The argument must be bound to a Go slice or array of
+// ints, floats, bools, strings or byte slices,
+// using [sqlite3.BindPointer] or [sqlite3.Pointer].
 func Register(db *sqlite3.Conn) {
 	sqlite3.CreateModule[array](db, "array", nil,
 		func(db *sqlite3.Conn, _, _, _ string, _ ...string) (array, error) {

ext/blobio/blob.go

@@ -23,7 +23,8 @@ import (
 //
 // Opens blobs for reading or writing.
 // The callback is invoked for each open blob,
-// and must be an [sqlite3.Pointer] to an [OpenCallback].
+// and must be bound to an [OpenCallback],
+// using [sqlite3.BindPointer] or [sqlite3.Pointer].
 // The optional args will be passed to the callback,
 // along with the [sqlite3.Blob] handle.
 //

json.go

@@ -12,6 +12,7 @@ import (
 // JSON returns a value that can be used as an argument to
 // [database/sql.DB.Exec], [database/sql.Row.Scan] and similar methods to
 // store value as JSON, or decode JSON into value.
+// JSON should NOT be used with [BindJSON] or [ResultJSON].
 func JSON(value any) any {
 	return jsonValue{value}
 }

pointer.go

@@ -1,8 +1,8 @@
 package sqlite3
 
-// Pointer returns a pointer to a value
-// that can be used as an argument to
+// Pointer returns a pointer to a value that can be used as an argument to
 // [database/sql.DB.Exec] and similar methods.
+// Pointer should NOT be used with [BindPointer] or [ResultPointer].
 //
 // https://sqlite.org/bindptr.html
 func Pointer[T any](val T) any {