Skip to content

Commit

Permalink
add index sorting deprecation warning
Browse files Browse the repository at this point in the history
  • Loading branch information
@PSeitz
PSeitz committed Apr 9, 2024
1 parent 74940e9 commit ddce4c3
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/index/index_meta.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,10 @@ impl Default for IndexSettings {
/// Presorting documents can greatly improve performance
/// in some scenarios, by applying top n
/// optimizations.
#[deprecated(
since = "0.22.0",
note = "We plan to remove index sorting in `0.23`. If you need index sorting, please comment on the related issue https://github.com/quickwit-oss/tantivy/issues/2352 and explain your use case."
)]
#[derive(Clone, Debug, Serialize, Deserialize, Eq, PartialEq)]
pub struct IndexSortByField {

Check warning on line 296 in src/index/index_meta.rs

View workflow job for this annotation

GitHub Actions / clippy

use of deprecated struct `index::index_meta::IndexSortByField`: We plan to remove index sorting in `0.23`. If you need index sorting, please comment on the related issue https://github.com/quickwit-oss/tantivy/issues/2352 and explain your use case. 

warning: use of deprecated struct `index::index_meta::IndexSortByField`: We plan to remove index sorting in `0.23`. If you need index sorting, please comment on the related issue https://github.com/quickwit-oss/tantivy/issues/2352 and explain your use case.
   --> src/index/index_meta.rs:296:12
    |
296 | pub struct IndexSortByField {
    |            ^^^^^^^^^^^^^^^^
/// The field to sort the documents by
Expand Down

0 comments on commit ddce4c3

Please sign in to comment.