Skip to content

Commit 5dee934

Browse files
author
xenodium
committed
Fixing checkdoc warnings
1 parent 0155751 commit 5dee934

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

chatgpt-shell.el

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -439,7 +439,7 @@ Or nil if none."
439439

440440
(defun chatgpt-shell-validate-no-system-prompt (command model settings)
441441
"Perform validation for COMMAND with MODEL and SETTINGS.
442-
Then enforce that there is no system prompt. This is useful for models like
442+
Then enforce that there is no system prompt. This is useful for models like
443443
OpenAI's o1 that do not allow one."
444444
(or (chatgpt-shell-openai--validate-command command model settings)
445445
(when (map-elt settings :system-prompt)
@@ -522,24 +522,26 @@ Downloaded from https://github.com/f/awesome-chatgpt-prompts."
522522
(message "Reloaded %d models" (length chatgpt-shell-models)))
523523

524524
(defcustom chatgpt-shell-model-filter nil
525-
"A function that is applied `chatgpt-shell-models' to determine
526-
which models should be shown in `chatgpt-shell-swap-model'."
525+
"Filter models to swap from using this function as a filter.
526+
527+
See `chatgpt-shell-allow-model-versions' and
528+
`chatgpt-shell-ignore-model-versions' as examples."
527529
:type 'function
528530
:group 'chatgpt-shell)
529531

530532
(defun chatgpt-shell-allow-model-versions (versions)
531-
"Return a predicate that accepts models only if their version
532-
appears in versions. This is intended for use with
533-
`chatgpt-shell-model-filter'."
533+
"Return a filter function to keep known model VERSIONS only.
534+
535+
Use with `chatgpt-shell-model-filter'."
534536
(lambda (models)
535537
(seq-filter (lambda (model)
536538
(member (map-elt model :version) versions))
537539
models)))
538540

539541
(defun chatgpt-shell-ignore-model-versions (versions)
540-
"A predicate intended for use with `chatgpt-shell-model-filter' to
541-
allow model versions specified in
542-
`chatgpt-shell-ignored-model-versions'."
542+
"Return a filter function to drop model VERSIONS.
543+
544+
Use with `chatgpt-shell-model-filter'."
543545
(lambda (models)
544546
(seq-filter (lambda (model)
545547
(not (member (map-elt model :version) versions)))

0 commit comments

Comments
 (0)