Skip to content

Commit 9832636

Browse files
committed
Add and update Godoc internal links
1 parent 57c073a commit 9832636

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

‎collection.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -417,7 +417,7 @@ func (c *Collection) Query(ctx context.Context, queryText string, nResults int,
417417

418418
// QueryWithOptions performs an exhaustive nearest neighbor search on the collection.
419419
//
420-
// - options: The options for the query. See QueryOptions for more information.
420+
// - options: The options for the query. See [QueryOptions] for more information.
421421
func (c *Collection) QueryWithOptions(ctx context.Context, options QueryOptions) ([]Result, error) {
422422
if options.QueryText == "" && len(options.QueryEmbedding) == 0 {
423423
return nil, errors.New("QueryText and QueryEmbedding options are empty")

‎db.go‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,9 @@ func NewDB() *DB {
6262
// will make this configurable (encoding, async writes, WAL-based writes, etc.).
6363
//
6464
// In addition to persistence for each added collection and document you can use
65-
// [DB.Export] and [DB.Import] to export and import the entire DB to/from a file,
66-
// which also works for the pure in-memory DB.
65+
// [DB.ExportToFile] / [DB.ExportToWriter] and [DB.ImportFromFile] /
66+
// [DB.ImportFromReader] to export and import the entire DB to/from a file or
67+
// writer/reader, which also works for the pure in-memory DB.
6768
func NewPersistentDB(path string, compress bool) (*DB, error) {
6869
if path == "" {
6970
path = "./chromem-go"
@@ -509,7 +510,7 @@ func (db *DB) CreateCollection(name string, metadata map[string]string, embeddin
509510
// ListCollections returns all collections in the DB, mapping name->Collection.
510511
// The returned map is a copy of the internal map, so it's safe to directly modify
511512
// the map itself. Direct modifications of the map won't reflect on the DB's map.
512-
// To do that use the DB's methods like CreateCollection() and DeleteCollection().
513+
// To do that use the DB's methods like [DB.CreateCollection] and [DB.DeleteCollection].
513514
// The map is not an entirely deep clone, so the collections themselves are still
514515
// the original ones. Any methods on the collections like Add() for adding documents
515516
// will be reflected on the DB's collections and are concurrency-safe.

0 commit comments

Comments
 (0)