Update doc comments on fast fields (#181)

master
Chris Tam 2023-12-30 04:10:52 -05:00 committed by GitHub
parent 32197431f7
commit 7ff33854a5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions

View File

@ -115,7 +115,7 @@ impl SchemaBuilder {
/// content of the field can be later restored from a Searcher. /// content of the field can be later restored from a Searcher.
/// Defaults to False. /// Defaults to False.
/// indexed (bool, optional): If true sets the field to be indexed. /// indexed (bool, optional): If true sets the field to be indexed.
/// fast (str, optional): Set the numeric options as a fast field. A /// fast (bool, optional): Set the numeric options as a fast field. A
/// fast field is a column-oriented fashion storage for tantivy. /// fast field is a column-oriented fashion storage for tantivy.
/// It is designed for the fast random access of some document /// It is designed for the fast random access of some document
/// fields given a document id. /// fields given a document id.
@ -152,7 +152,7 @@ impl SchemaBuilder {
/// content of the field can be later restored from a Searcher. /// content of the field can be later restored from a Searcher.
/// Defaults to False. /// Defaults to False.
/// indexed (bool, optional): If true sets the field to be indexed. /// indexed (bool, optional): If true sets the field to be indexed.
/// fast (str, optional): Set the numeric options as a fast field. A /// fast (bool, optional): Set the numeric options as a fast field. A
/// fast field is a column-oriented fashion storage for tantivy. /// fast field is a column-oriented fashion storage for tantivy.
/// It is designed for the fast random access of some document /// It is designed for the fast random access of some document
/// fields given a document id. /// fields given a document id.
@ -189,7 +189,7 @@ impl SchemaBuilder {
/// content of the field can be later restored from a Searcher. /// content of the field can be later restored from a Searcher.
/// Defaults to False. /// Defaults to False.
/// indexed (bool, optional): If true sets the field to be indexed. /// indexed (bool, optional): If true sets the field to be indexed.
/// fast (str, optional): Set the numeric options as a fast field. A /// fast (bool, optional): Set the numeric options as a fast field. A
/// fast field is a column-oriented fashion storage for tantivy. /// fast field is a column-oriented fashion storage for tantivy.
/// It is designed for the fast random access of some document /// It is designed for the fast random access of some document
/// fields given a document id. /// fields given a document id.
@ -226,7 +226,7 @@ impl SchemaBuilder {
/// content of the field can be later restored from a Searcher. /// content of the field can be later restored from a Searcher.
/// Defaults to False. /// Defaults to False.
/// indexed (bool, optional): If true sets the field to be indexed. /// indexed (bool, optional): If true sets the field to be indexed.
/// fast (str, optional): Set the numeric options as a fast field. A /// fast (bool, optional): Set the numeric options as a fast field. A
/// fast field is a column-oriented fashion storage for tantivy. /// fast field is a column-oriented fashion storage for tantivy.
/// It is designed for the fast random access of some document /// It is designed for the fast random access of some document
/// fields given a document id. /// fields given a document id.
@ -263,7 +263,7 @@ impl SchemaBuilder {
/// content of the field can be later restored from a Searcher. /// content of the field can be later restored from a Searcher.
/// Defaults to False. /// Defaults to False.
/// indexed (bool, optional): If true sets the field to be indexed. /// indexed (bool, optional): If true sets the field to be indexed.
/// fast (str, optional): Set the date options as a fast field. A fast /// fast (bool, optional): Set the date options as a fast field. A fast
/// field is a column-oriented fashion storage for tantivy. It is /// field is a column-oriented fashion storage for tantivy. It is
/// designed for the fast random access of some document fields /// designed for the fast random access of some document fields
/// given a document id. /// given a document id.
@ -386,7 +386,7 @@ impl SchemaBuilder {
/// content of the field can be later restored from a Searcher. /// content of the field can be later restored from a Searcher.
/// Defaults to False. /// Defaults to False.
/// indexed (bool, optional): If true sets the field to be indexed. /// indexed (bool, optional): If true sets the field to be indexed.
/// fast (str, optional): Set the bytes options as a fast field. A fast /// fast (bool, optional): Set the bytes options as a fast field. A fast
/// field is a column-oriented fashion storage for tantivy. It is /// field is a column-oriented fashion storage for tantivy. It is
/// designed for the fast random access of some document fields /// designed for the fast random access of some document fields
/// given a document id. /// given a document id.
@ -433,7 +433,7 @@ impl SchemaBuilder {
/// content of the field can be later restored from a Searcher. /// content of the field can be later restored from a Searcher.
/// Defaults to False. /// Defaults to False.
/// indexed (bool, optional): If true sets the field to be indexed. /// indexed (bool, optional): If true sets the field to be indexed.
/// fast (str, optional): Set the IP address options as a fast field. A /// fast (bool, optional): Set the IP address options as a fast field. A
/// fast field is a column-oriented fashion storage for tantivy. It /// fast field is a column-oriented fashion storage for tantivy. It
/// is designed for the fast random access of some document fields /// is designed for the fast random access of some document fields
/// given a document id. /// given a document id.