From: Erik Mackdanz Date: Thu, 28 Nov 2024 20:56:09 +0000 (-0600) Subject: docs X-Git-Url: https://git.humopery.space/?a=commitdiff_plain;h=4efea02b7ae0f5e8e2ab42513461182f924de890;p=vecsearch.git docs --- diff --git a/src/main.rs b/src/main.rs index c6bea03..2d9d9d7 100644 --- a/src/main.rs +++ b/src/main.rs @@ -32,7 +32,8 @@ //! For example: //! //! ```text -//! $ PASSWORD=$(gpg -d pw-cvmigrator.gpg) candlevec init-database +//! $ export PASSWORD=$(gpg -d pw-cvmigrator.gpg) +//! $ candlevec init-database //! maybe creating the database //! database vsearch exists already //! maybe creating database objects @@ -46,13 +47,14 @@ //! table (not superuser). //! //! ```text -//! $ PASSWORD=$(gpg -d pw-cvmigrator.gpg) candlevec index --file testdata/0 +//! $ export PASSWORD=$(gpg -d pw-cvmigrator.gpg) +//! $ candlevec index --file testdata/0 //! indexing a file //! Loaded and encoded 59.479µs //! Took 14.982262ms -//! $ PASSWORD=$(gpg -d pw-cvmigrator.gpg) candlevec index --file testdata/1 +//! $ candlevec index --file testdata/1 //! ... -//! $ PASSWORD=$(gpg -d pw-cvmigrator.gpg) candlevec index --file testdata/2 +//! $ candlevec index --file testdata/2 //! ... //! ``` //! @@ -66,7 +68,8 @@ //! superuser). //! //! ```text -//! $ PASSWORD=$(gpg -d pw-cvmigrator.gpg) candlevec search --search feline +//! $ export PASSWORD=$(gpg -d pw-cvmigrator.gpg) +//! $ candlevec search --search feline //! searching for document matches //! Loaded and encoded 49.306µs //! Took 14.452557ms