Skip to content

Commit 8426a4b

Browse files
chore(doc): auto generate docs
1 parent cfde362 commit 8426a4b

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

doc/phoenix.nvim.txt

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,44 @@ USAGE *phoenix.nvim-phoenix-usage*
4545
require('phoenix').setup()
4646
<
4747

48-
all config in `vim.g.phoenix` option table see source file …
48+
default config and custom in `vim.g.phoenix` option table.
49+
50+
>
51+
{
52+
filetypes = { '*' },
53+
-- Dictionary related settings
54+
dict = {
55+
-- Maximum number of words to store in the dictionary
56+
-- Higher values consume more memory but provide better completions
57+
max_words = 50000,
58+
59+
-- Minimum word length to be considered for completion
60+
-- Shorter words may create noise in completions
61+
min_word_length = 2,
62+
-- Time factor weight for sorting completions (0-1)
63+
-- Higher values favor recently used items more strongly
64+
recency_weight = 0.3,
65+
66+
-- Base weight for frequency in sorting (0-1)
67+
-- Complements recency_weight, should sum to 1
68+
frequency_weight = 0.7,
69+
},
70+
71+
-- Performance related settings
72+
scan = {
73+
cache_ttl = 5000,
74+
-- Number of items to process in each batch
75+
-- Higher values improve speed but may cause stuttering
76+
batch_size = 1000,
77+
-- Ignored the file or dictionary which matched the pattern
78+
ignore_patterns = {},
79+
80+
-- Throttle delay for dictionary updates in milliseconds
81+
-- Prevents excessive CPU usage during rapid file changes
82+
throttle_ms = 100,
83+
},
84+
}
85+
<
4986

5087

5188
LICENSE MIT *phoenix.nvim-phoenix-license-mit*

0 commit comments

Comments
 (0)