Skip to content

Commit 004293d

Browse files
committed
utility/telescope: document missing layout options
1 parent 95f2638 commit 004293d

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

modules/plugins/utility/telescope/telescope.nix

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -95,42 +95,42 @@
9595
options = {
9696
horizontal = {
9797
prompt_position = mkOption {
98-
description = "";
99-
type = str;
98+
type = enum ["top" "bottom"];
10099
default = "top";
100+
description = "Where to place prompt window";
101101
};
102102

103103
preview_width = mkOption {
104-
description = "";
105104
type = float;
106105
default = 0.55;
106+
description = "Change the width of Telescope's preview window";
107107
};
108108
};
109109

110110
vertical = {
111111
mirror = mkOption {
112-
description = "";
113112
type = bool;
114113
default = false;
114+
description = "Flip the location of the results/prompt and preview windows";
115115
};
116116
};
117117

118118
width = mkOption {
119-
description = "";
120119
type = float;
121120
default = 0.8;
121+
description = "How wide to make Telescope's entire layout";
122122
};
123123

124124
height = mkOption {
125-
description = "";
126125
type = float;
127126
default = 0.8;
127+
description = "How tall to make Telescope's entire layout";
128128
};
129129

130130
preview_cutoff = mkOption {
131-
description = "";
132131
type = int;
133132
default = 120;
133+
description = "When lines are less than this value, the preview will be disabled";
134134
};
135135
};
136136
};
@@ -145,12 +145,11 @@
145145
file_ignore_patterns = mkOption {
146146
type = listOf str;
147147
default = ["node_modules" "%.git/" "dist/" "build/" "target/" "result/"];
148+
descriptions = "File patterns to omit from Telescope results";
148149
};
149150

150-
color_devicons = mkOption {
151-
type = bool;
152-
default = true;
153-
description = "Boolean if devicons should be enabled or not.";
151+
color_devicons = mkEnableOption {
152+
description = "devicons";
154153
};
155154

156155
path_display = mkOption {
@@ -168,7 +167,7 @@
168167
winblend = mkOption {
169168
type = int;
170169
default = 0;
171-
description = "pseudo-transparency of keymap hints floating window";
170+
description = "Pseudo-transparency of keymap hints floating window";
172171
};
173172

174173
extensions = mkOption {

0 commit comments

Comments
 (0)