mu4e-headers: Improve docstring for 'mu4e-headers-results-limit'

Add a few notes on how the limit is used.
This commit is contained in:
Dirk-Jan C. Binnema
2019-10-20 14:28:41 +03:00
parent 3a8ceeea92
commit 4cb3ca3585

View File

@ -109,7 +109,15 @@ indexing operation showed changes."
quite a bit, especially when `mu4e-headers-include-related' is quite a bit, especially when `mu4e-headers-include-related' is
non-nil. Set to -1 for no limits, and you temporarily (for one non-nil. Set to -1 for no limits, and you temporarily (for one
query) ignore the limit by pressing a C-u before invoking the query) ignore the limit by pressing a C-u before invoking the
search." search.
Note that there are a few complications when
`mu4e-headers-include-related' is enabled: mu perform *two*
queries; the first one with this limit set, and then a second
(unlimited) query for all messages that are related to the first
matches. We then limit this second result as well, favoring the
messages that were found in the first set (the \"leaders\").
"
:type '(choice (const :tag "Unlimited" -1) :type '(choice (const :tag "Unlimited" -1)
(integer :tag "Limit")) (integer :tag "Limit"))
:group 'mu4e-headers) :group 'mu4e-headers)