ui.gadgets.editors: tweak caret-style and fix docs

[factor.git] / basis / ui / gadgets / editors / editors-docs.factor

diff --git a/basis/ui/gadgets/editors/editors-docs.factor b/basis/ui/gadgets/editors/editors-docs.factor
index 180d5c46fc8f35bf7061aa5d002c65776ad34949..60dddd03a1fdbef724970a3be69e7a110a306b09 100644 (file)
--- a/basis/ui/gadgets/editors/editors-docs.factor
+++ b/basis/ui/gadgets/editors/editors-docs.factor
@@ -33,6 +33,17 @@ HELP: <editor>
 
 { editor-caret editor-mark } related-words
 
+HELP: caret-style
+{ $description "Caret styles available:"
+{ $table
+  { "Value" "Shape" }
+  { { $link +line+ } "line (default)" }
+  { { $link +box+ } "box" }
+  { { $link +filled+ } "filled box" }
+}
+}
+{ $references "Set desired caret style in your .factor-rc file" "rc-files" } ;
+
 HELP: editor-caret
 { $values { "editor" editor } { "loc" "a pair of integers" } }
 { $description "Outputs the current caret location as a line/column number pair." } ;