Fix Instances of `if` Being Spelt as `iff` in Documentation

quickwit-oss / tantivy

Tantivy is a full-text search engine library inspired by Apache Lucene and written in Rust

MIT License

11.41k stars 627 forks source link

Fix Instances of `if` Being Spelt as `iff` in Documentation #2424

Closed ultrabear closed 1 month ago

ultrabear commented 1 month ago

Hi, I used tantivy for a project and noticed if being written as iff in the NumericOptions docs as I browsed, I doubt these spellings were intentional and a ripgrep later revealed 16 potential locations where this spelling error had occurred.

This PR changes the spelling in all 16 locations that were found through automated means to say if instead of iff, it also changes fieldnorm to fieldnorms in 2 areas (that were on the same line as an iff) to make the grammar flow better.

fulmicoton commented 1 month ago

https://en.wikipedia.org/wiki/If_and_only_if

ultrabear commented 1 month ago

Nilstrieb commented 1 month ago

"true iff" could be expressed by just "whether", which is a lot simpler