Skip to content

Commit

Permalink
Improve Docs Readability (#1380)
Browse files Browse the repository at this point in the history
Signed-off-by: Ryan Russell <[email protected]>
  • Loading branch information
ryanrussell authored Jun 2, 2022
1 parent f0a2b1c commit ca836b6
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ For instance, when the phrase query "the art of war" does not match "the war of
To make it possible, it is possible to specify in the schema that a field should store positions in addition to being indexed.

The token positions of all of the terms are then stored in a separate file with the extension `.pos`.
The [TermInfo](src/postings/term_info.rs) gives an offset (expressed in position this time) in this file. As we iterate throught the docset,
The [TermInfo](src/postings/term_info.rs) gives an offset (expressed in position this time) in this file. As we iterate through the docset,
we advance the position reader by the number of term frequencies of the current document.

## [fieldnorms/](src/fieldnorms): Here is my doc, how many tokens in this field?
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Tantivy 0.17

Tantivy 0.16.2
================================
- Bugfix in FuzzyTermQuery. (tranposition_cost_one was not doing anything)
- Bugfix in FuzzyTermQuery. (transposition_cost_one was not doing anything)

Tantivy 0.16.1
========================
Expand Down
2 changes: 1 addition & 1 deletion doc/src/index_sorting.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Note: Tantivy 0.16 does not do this optimization yet.
In principle there are many algorithms possible that exploit the monotonically increasing nature. (aggregations maybe?)

## Usage
The index sorting can be configured setting [`sort_by_field`](https://github.com/quickwit-oss/tantivy/blob/000d76b11a139a84b16b9b95060a1c93e8b9851c/src/core/index_meta.rs#L238) on `IndexSettings` and passing it to a `IndexBuilder`. As of tantvy 0.16 only fast fields are allowed to be used.
The index sorting can be configured setting [`sort_by_field`](https://github.com/quickwit-oss/tantivy/blob/000d76b11a139a84b16b9b95060a1c93e8b9851c/src/core/index_meta.rs#L238) on `IndexSettings` and passing it to a `IndexBuilder`. As of Tantivy 0.16 only fast fields are allowed to be used.

```
let settings = IndexSettings {
Expand Down
2 changes: 1 addition & 1 deletion doc/src/json.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ If one more json field is defined, things get even more complicated.
## Default json field

If the schema contains a text field called "text" and a json field that is set as a default field:
`text:hello` could be reasonably interpreted as targetting the text field or as targetting the json field called `json_dynamic` with the json_path "text".
`text:hello` could be reasonably interpreted as targeting the text field or as targeting the json field called `json_dynamic` with the json_path "text".

If there is such an ambiguity, we decide to only search in the "text" field: `text:hello`.

Expand Down
2 changes: 1 addition & 1 deletion src/aggregation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Tantivy's aggregations have been designed to mimic the
The code is organized in submodules:

## bucket
Contains all bucket aggregations, like range aggregation. These bucket aggregations group documents into buckets and can contain sub-aggegations.
Contains all bucket aggregations, like range aggregation. These bucket aggregations group documents into buckets and can contain sub-aggregations.

## metric
Contains all metric aggregations, like average aggregation. Metric aggregations do not have sub aggregations.
Expand Down
2 changes: 1 addition & 1 deletion src/fastfield/writer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ impl IntFastFieldWriter {
self.vals.mem_usage()
}

/// Returns the field that this writer is targetting.
/// Returns the field that this writer is targeting.
pub fn field(&self) -> Field {
self.field
}
Expand Down

0 comments on commit ca836b6

Please sign in to comment.