[PATCH] Fix documentation for notmuch--tag-hook functions

[PATCH] Fix documentation for notmuch--tag-hook functions

[Daniel Schoepe]

The second argument to notmuch-tag is now called tag-changes, but the
documentation for notmuch-before-tag-hook and notmuch-after-tag-hook
still used the old argument name `tags'. This resulted in broken hooks
when following the documentation.
---
 emacs/notmuch-tag.el | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/emacs/notmuch-tag.el b/emacs/notmuch-tag.el
index f54aa9d..c7f62c9 100644
--- a/emacs/notmuch-tag.el
+++ b/emacs/notmuch-tag.el
@@ -265,7 +265,7 @@ changed (the normal case) are shown using formats from
 (defcustom notmuch-before-tag-hook nil
   "Hooks that are run before tags of a message are modified.
 
-'tags' will contain the tags that are about to be added or removed as
+'tag-changes' will contain the tags that are about to be added or removed as
 a list of strings of the form \"+TAG\" or \"-TAG\".
 'query' will be a string containing the search query that determines
 the messages that are about to be tagged"
@@ -277,7 +277,7 @@ the messages that are about to be tagged"
 (defcustom notmuch-after-tag-hook nil
   "Hooks that are run after tags of a message are modified.
 
-'tags' will contain the tags that were added or removed as
+'tag-changes' will contain the tags that were added or removed as
 a list of strings of the form \"+TAG\" or \"-TAG\".
 'query' will be a string containing the search query that determines
 the messages that were tagged"
-- 
2.4.3

Re: [PATCH] Fix documentation for notmuch--tag-hook functions

[Tomi Ollila]

On Wed, Jun 17 2015, Daniel Schoepe <daniel@schoepe.org> wrote:

> The second argument to notmuch-tag is now called tag-changes, but the
> documentation for notmuch-before-tag-hook and notmuch-after-tag-hook
> still used the old argument name `tags'. This resulted in broken hooks
> when following the documentation.

LGTM.

Tomi

> ---
>  emacs/notmuch-tag.el | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/emacs/notmuch-tag.el b/emacs/notmuch-tag.el
> index f54aa9d..c7f62c9 100644
> --- a/emacs/notmuch-tag.el
> +++ b/emacs/notmuch-tag.el
> @@ -265,7 +265,7 @@ changed (the normal case) are shown using formats from
>  (defcustom notmuch-before-tag-hook nil
>    "Hooks that are run before tags of a message are modified.
>  
> -'tags' will contain the tags that are about to be added or removed as
> +'tag-changes' will contain the tags that are about to be added or removed as
>  a list of strings of the form \"+TAG\" or \"-TAG\".
>  'query' will be a string containing the search query that determines
>  the messages that are about to be tagged"
> @@ -277,7 +277,7 @@ the messages that are about to be tagged"
>  (defcustom notmuch-after-tag-hook nil
>    "Hooks that are run after tags of a message are modified.
>  
> -'tags' will contain the tags that were added or removed as
> +'tag-changes' will contain the tags that were added or removed as
>  a list of strings of the form \"+TAG\" or \"-TAG\".
>  'query' will be a string containing the search query that determines
>  the messages that were tagged"
> -- 
> 2.4.3
>
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch

Re: [PATCH] Fix documentation for notmuch--tag-hook functions

[David Bremner]

Daniel Schoepe <daniel@schoepe.org> writes:

> The second argument to notmuch-tag is now called tag-changes, but the
> documentation for notmuch-before-tag-hook and notmuch-after-tag-hook
> still used the old argument name `tags'. This resulted in broken hooks
> when following the documentation.

pushed, thanks.

d