]> Humopery - vecsearch.git/commitdiff
docs
authorErik Mackdanz <erikmack@gmail.com>
Thu, 28 Nov 2024 20:56:09 +0000 (14:56 -0600)
committerErik Mackdanz <erikmack@gmail.com>
Thu, 28 Nov 2024 20:56:09 +0000 (14:56 -0600)
src/main.rs

index c6bea03a40801d95ffb91da2ab680bf2b3a59a62..2d9d9d7c07e6a049cfe08207b83e565b621d113a 100644 (file)
@@ -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
 //! 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