Skip to content

Commit

Permalink
docs: update setting documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
cbochs committed Mar 26, 2024
1 parent c78b6b4 commit 2561382
Showing 1 changed file with 9 additions and 11 deletions.
20 changes: 9 additions & 11 deletions lua/portal/settings.lua
Original file line number Diff line number Diff line change
Expand Up @@ -6,31 +6,29 @@ end

---@class Portal.Settings
local DEFAULT_SETTINGS = {
---An ordered list of keys for labelling portals. Labels will applied in
---order, according to their index.
---Ordered list of keys for labelling portals
---@type string[]
labels = { "j", "k", "h", "l" },

---Select the first portal when there is only one result
---@type boolean
select_first = false,

---@alias Portal.Slots integer | Portal.Predicate | Portal.Predicate[]

-- TODO: explain slots
---The maximum number of results for any search.
---
---@type Portal.Slots
---The maximum number of results to return or a list of predicates to match
---or "fill". By default, uses the number of labels as a maximum number of
---results. See the Slots section for more information.
---@type Portal.Slots | nil
slots = nil,

---The base filter applied to every search.
---The default filter to be applied to every search result.
---@type Portal.Predicate | nil
filter = nil,

-- TODO: explain lookback
---The maximum number of results to consider when performing a Portal query
---@type integer
lookback = 100,

---The raw window options used for the portal window
---Window options for Portal windows
---@type vim.api.keyset.win_config
win_opts = {
width = 80,
Expand Down

0 comments on commit 2561382

Please sign in to comment.