[PATCH] Expand docstrings about fcc using notmuch-insert

[Mark Walters]

Hi

Many thanks for doing this (and bringing this to out attention). I have
a couple of minor suggestions for tweaking what you have written, but I
am not certain they are improvements, so comments gratefully received.

On Tue, 11 Oct 2016, Keith Amidon <camalot at picnicpark.org> wrote:
> This commit expands docstrings for notmuch-fcc-dirs and
> notmuch-maildir-fcc-with-notmuch-insert to describe how quoted strings
> are processed and make the ability to configure sent folders containing
> whitespace more discoverable.
> ---
>  emacs/notmuch-maildir-fcc.el | 13 ++++++++++---
>  1 file changed, 10 insertions(+), 3 deletions(-)
>
> diff --git a/emacs/notmuch-maildir-fcc.el b/emacs/notmuch-maildir-fcc.el
> index 95e5650..cfe1931 100644
> --- a/emacs/notmuch-maildir-fcc.el
> +++ b/emacs/notmuch-maildir-fcc.el
> @@ -54,7 +54,10 @@ If `notmuch-maildir-use-notmuch-insert' is set (the default) then
>  the header should be of the form \"folder +tag1 -tag2\" where
>  folder is the folder (relative to the notmuch mailstore) to store
>  the message in, and tag1 and tag2 are tag changes to apply to the
> -stored message.
> +stored message.  This string is split using `split-string-and-unquote',
> +so a folder name containing whitespace can be specified by
> +quoting the whitespace with an immediately preceeding backslash
> +or surrounding the entire folder name in double quotes.
>  
>  If `notmuch-maildir-use-notmuch-insert' is nil then the Fcc
>  header should be the directory where the message should be
> @@ -230,8 +233,12 @@ should be a list of tag changes to apply to the inserted message."
>  The fcc-header should be of the form \"folder +tag1 -tag2\" where
>  folder is the folder (relative to the notmuch mailstore) to store
>  the message in, and tag1 and tag2 are tag changes to apply to the
> -stored message. If CREATE is non-nil then create the folder if
> -necessary."
> +stored message. This string is split using `split-string-and-unquote',
> +so a folder name containing whitespace can be specified by quoting
> +the whitespace with an immediately preceeding backslash or
> +surrounding the entire folder name in double quotes.

Maybe "...containing whitespace can be specified by quoting each
whitespace character with an immediately preceding backslash ..."

Or maybe "...so a folder name containing spaces can be specified by
quoting each space with an immediately preceding backslash ..."

The former is more accurate but the latter is simpler, and I don't think
tabs and newlines in filenames occur often enough to care about (in fact
I am not sure we cope with a newline in an fcc header anyway)

Best wishes

Mark


> +
> +If CREATE is non-nil then create the folder if necessary."
>    (let* ((args (split-string-and-unquote fcc-header))
>  	 (folder (car args))
>  	 (tags (cdr args)))
> -- 
> 2.10.0
>
> _______________________________________________
> notmuch mailing list
> notmuch at notmuchmail.org
> https://notmuchmail.org/mailman/listinfo/notmuch