Update docstrings according to the tips

This commit is contained in:
Jai Flack 2022-03-28 21:41:40 +10:00
parent d827311878
commit 0bdaf4f162
No known key found for this signature in database
GPG key ID: B0073AB365D0807D

View file

@ -63,32 +63,26 @@ Note that this should be a list. I.e., do NOT use the following:
(setq gnus-search-mu-switches \"-u -r\") (setq gnus-search-mu-switches \"-u -r\")
Instead, use this: Instead, use this:
(setq gnus-search-mu-switches \\='(\"-u\" \"-r\")) (setq gnus-search-mu-switches \\='(\"-u\" \"-r\"))
This can also be set per-server." This can also be set per-server."
:type '(repeat (string)) :type '(repeat (string))
:group 'gnus-search) :group 'gnus-search)
(defcustom gnus-search-mu-remove-prefix (expand-file-name "Mail/" "~") (defcustom gnus-search-mu-remove-prefix (expand-file-name "Mail/" "~")
"A prefix to remove from each file name returned by mu in order "A prefix to remove from the mu results to get a group name.
to get a group name. Usually this will be set to the path to your Usually this will be set to the path to your mail directory. This
mail directory. can also be set per-server."
This can also be set per-server."
:type '(string) :type '(string)
:group 'gnus-search) :group 'gnus-search)
(defcustom gnus-search-mu-config-directory (defcustom gnus-search-mu-config-directory
(expand-file-name "~/.cache/mu") (expand-file-name "~/.cache/mu")
"Configuration directory for mu. "Configuration directory for mu.
This can also be set per-server." This can also be set per-server."
:type 'file :type 'file
:group 'gnus-search) :group 'gnus-search)
(defcustom gnus-search-mu-raw-queries-p nil (defcustom gnus-search-mu-raw-queries-p nil
"If t, all mu engines will only accept raw search query "If t, all mu engines will only accept raw search query strings.
strings.
This can also be set per-server." This can also be set per-server."
:type 'boolean :type 'boolean
:group 'gnus-search) :group 'gnus-search)