Fix docstring of c-ts-mode-indent-style
authorYuan Fu <casouri@gmail.com>
Sat, 30 Nov 2024 05:11:19 +0000 (21:11 -0800)
committerYuan Fu <casouri@gmail.com>
Sat, 30 Nov 2024 05:13:31 +0000 (21:13 -0800)
* lisp/progmodes/c-ts-mode.el (c-ts-mode-indent-style): Make the
docstring reflect what's expected by the code.

lisp/progmodes/c-ts-mode.el

index 31f822b219d74582f1573f753ee617e167afec92..e08e99cf087ae01c97c885bcf09b3f69d5736398 100644 (file)
@@ -147,10 +147,11 @@ symbol."
 (defcustom c-ts-mode-indent-style 'gnu
   "Style used for indentation.
 
-The selected style could be one of GNU, K&R, LINUX or BSD.  If
-one of the supplied styles doesn't suffice, the value could be
-a function instead.  This function is expected to return a list
-that follows the form of `treesit-simple-indent-rules'."
+The selected style could be one of GNU, K&R, LINUX or BSD.  If the
+supplied styles don't suffice, the value could be a function instead.
+This function takes no arguments and is expected to return a list of
+indent RULEs as described in `treesit-simple-indent-rules'.  Note that
+the list of RULEs doesn't need to contain the language symbol."
   :version "29.1"
   :type '(choice (symbol :tag "Gnu" gnu)
                  (symbol :tag "K&R" k&r)