Minor doc updates

pull/585/head
Arijit Basu 2 years ago
parent 037d6e9088
commit f03dfcc759

@ -197,7 +197,7 @@ Type: [Style](https://xplr.dev/en/style)
The default search algorithm The default search algorithm
Type: [Search Algorithm](https://xplr.dev/en/searching#search-algorithm) Type: [Search Algorithm](https://xplr.dev/en/searching#algorithm)
#### xplr.config.general.search.unordered #### xplr.config.general.search.unordered

@ -6,12 +6,12 @@ generally appears between filters and sorters in the `Sort & filter` panel.
Example: Example:
``` ```
/fzy↓abc fzy:foo
``` ```
This line means that the nodes visible on the table are being filtered using the This line means that the nodes visible on the table are being filtered using the
[fuzzy matching][1] algorithm. The arrow means that ranking based ordering is [fuzzy matching][1] algorithm on the input `foo`. The arrow means that ranking based
being applied, i.e. [sorters][2] are being ignored. ordering is being applied, i.e. [sorters][2] are being ignored.
## Node Searcher Applicable ## Node Searcher Applicable
@ -36,7 +36,7 @@ Type: nullable string
### algorithm ### algorithm
Search algorithm to use. Defaults to `Fuzzy`. Search algorithm to use. Defaults to [xplr.config.general.search.algorithm][8]
It can be one of the following: It can be one of the following:
@ -46,7 +46,7 @@ It can be one of the following:
### unordered ### unordered
Whether to skip ordering the search result by algorithm based ranking. Defaults Whether to skip ordering the search result by algorithm based ranking. Defaults
to `false`. to [xplr.config.general.search.unordered][9]
Type: boolean Type: boolean
@ -57,6 +57,7 @@ local searcher = {
pattern = "pattern to search", pattern = "pattern to search",
recoverable_focus = "/path/to/focus/on/cancel", recoverable_focus = "/path/to/focus/on/cancel",
algorithm = "Fuzzy", algorithm = "Fuzzy",
unordered = false,
} }
xplr.util.explore({ searcher = searcher }) xplr.util.explore({ searcher = searcher })
@ -71,3 +72,5 @@ See [xplr.util.explore][6]
[5]: #algorithm [5]: #algorithm
[6]: xplr.util.md#explore [6]: xplr.util.md#explore
[7]: #unordered [7]: #unordered
[8]: general-config.md#xplrconfiggeneralsearchalgorithm
[9]: general-config.md#xplrconfiggeneralsearchunordered

@ -258,7 +258,7 @@ xplr.config.general.selection.item.style = {}
-- The default search algorithm -- The default search algorithm
-- --
-- Type: [Search Algorithm](https://xplr.dev/en/searching#search-algorithm) -- Type: [Search Algorithm](https://xplr.dev/en/searching#algorithm)
xplr.config.general.search.algorithm = "Fuzzy" xplr.config.general.search.algorithm = "Fuzzy"
-- The default search ordering -- The default search ordering
@ -473,8 +473,8 @@ xplr.config.general.sort_and_filter_ui.filter_identifiers = {
-- --
-- Type: { format = nullable string, style = [Style](https://xplr.dev/en/style) } -- Type: { format = nullable string, style = [Style](https://xplr.dev/en/style) }
xplr.config.general.sort_and_filter_ui.search_identifiers = { xplr.config.general.sort_and_filter_ui.search_identifiers = {
Fuzzy = { format = "fzy:/", style = {} }, Fuzzy = { format = "fzy:", style = {} },
Regex = { format = "reg:/", style = {} }, Regex = { format = "reg:", style = {} },
} }
-- The shape of ordered indicator for search ordering identifiers in Sort & filter panel. -- The shape of ordered indicator for search ordering identifiers in Sort & filter panel.

Loading…
Cancel
Save