unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: David Bremner <david@tethera.net>
To: Mark Walters <markwalters1009@gmail.com>, notmuch@notmuchmail.org
Subject: Re: [PATCH v2 2/3] contrib: pick: remove hack notmuch-pick-show-match-message-with-wait
Date: Sun, 30 Jun 2013 13:30:42 -0300	[thread overview]
Message-ID: <87li5rtvbh.fsf@zancas.localnet> (raw)
In-Reply-To: <1372582512-10777-3-git-send-email-markwalters1009@gmail.com>

Mark Walters <markwalters1009@gmail.com> writes:

> +(defvar notmuch-pick-open-target nil)
> +(make-variable-buffer-local 'notmuch-pick-open-target)

What do people think about adding a code style suggestion/requirement
for elisp that all variables have docstrings, even if intended for
internal use?  It's true the existing code doesn't really meet this
standard.

>  (defvar notmuch-pick-buffer-name nil)
>  (make-variable-buffer-local 'notmuch-pick-buffer-name)
>  ;; This variable is the window used for the message pane. It is set
> @@ -349,8 +351,8 @@ Does NOT change the database."
>    (notmuch-pick (notmuch-search-find-thread-id)
>                  notmuch-search-query-string
>  		nil
> -                (notmuch-prettify-subject (notmuch-search-find-subject)))
> -  (notmuch-pick-show-match-message-with-wait))
> +                (notmuch-prettify-subject (notmuch-search-find-subject))
> +		t))

I think my previous complaint can be reformulated as (essentially) both
notmuch-pick and notmuch-pick-open-target could use (better) docstrings.

As you say, the hack removed is quite horrible, so I'd be willing to
merge the patches anyway. OTOH, more documentation might make it so that
more than one person can understand the notmuch-pick code.

d

  reply	other threads:[~2013-06-30 16:30 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-06-30  8:55 [PATCH v2 0/3] Contrib: Pick: Remove horrible hack Mark Walters
2013-06-30  8:55 ` [PATCH v2 1/3] contrib: pick: if no target specified go to first matching message Mark Walters
2013-06-30 16:05   ` David Bremner
2013-06-30  8:55 ` [PATCH v2 2/3] contrib: pick: remove hack notmuch-pick-show-match-message-with-wait Mark Walters
2013-06-30 16:30   ` David Bremner [this message]
2013-06-30 21:15     ` Mark Walters
2013-06-30 21:18       ` [PATCH] contrib: pick: add a docstring for the main notmuch-pick function Mark Walters
2013-07-01  3:07       ` [PATCH v2 2/3] contrib: pick: remove hack notmuch-pick-show-match-message-with-wait David Bremner
2013-06-30  8:55 ` [PATCH v2 3/3] contrib: pick: fix refresh result Mark Walters
2013-06-30 16:39   ` David Bremner
2013-07-04  3:48 ` [PATCH v2 0/3] Contrib: Pick: Remove horrible hack David Bremner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://notmuchmail.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87li5rtvbh.fsf@zancas.localnet \
    --to=david@tethera.net \
    --cc=markwalters1009@gmail.com \
    --cc=notmuch@notmuchmail.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).