[PATCH 0/4] contrib: pick: add docstrings to several functions

[PATCH 0/4] contrib: pick: add docstrings to several functions

[Mark Walters]

This series adds docstrings to several previously undocumented
functions in notmuch-pick. It is probably independent of the previous
series id:1372665243-7675-1-git-send-email-markwalters1009@gmail.com
but I haven't checked that so safest to apply on top of it.

Best wishes

Mark



Mark Walters (4):
  pick: contrib: document notmuch-pick-show-out
  pick: contrib: document notmuch-pick-refresh-result
  pick: contrib: document notmuch-pick-message-window-kill-hook
  contrib: pick: document several of the tree/forest insertion
    functions.

 contrib/notmuch-pick/notmuch-pick.el |   23 +++++++++++++++++++++--
 1 files changed, 21 insertions(+), 2 deletions(-)

-- 
1.7.9.1

[PATCH 1/4] pick: contrib: document notmuch-pick-show-out

[Mark Walters]

---
 contrib/notmuch-pick/notmuch-pick.el |    5 +++++
 1 files changed, 5 insertions(+), 0 deletions(-)

diff --git a/contrib/notmuch-pick/notmuch-pick.el b/contrib/notmuch-pick/notmuch-pick.el
index 7c313e7..c436bf1 100644
--- a/contrib/notmuch-pick/notmuch-pick.el
+++ b/contrib/notmuch-pick/notmuch-pick.el
@@ -214,6 +214,11 @@ if the user has loaded a different buffer in that window.")
 (fset 'notmuch-pick-mode-map notmuch-pick-mode-map)
 
 (defun notmuch-pick-setup-show-out ()
+  "Set up the keymap for showing a thread
+
+This uses the value of the defcustom notmuch-pick-show-out to
+decide whether to show a message in the message pane or in the
+whole window."
   (let ((map notmuch-pick-mode-map))
     (if notmuch-pick-show-out
 	(progn
-- 
1.7.9.1

[PATCH 2/4] pick: contrib: document notmuch-pick-refresh-result

[Mark Walters]

---
 contrib/notmuch-pick/notmuch-pick.el |    5 +++++
 1 files changed, 5 insertions(+), 0 deletions(-)

diff --git a/contrib/notmuch-pick/notmuch-pick.el b/contrib/notmuch-pick/notmuch-pick.el
index c436bf1..50686f0 100644
--- a/contrib/notmuch-pick/notmuch-pick.el
+++ b/contrib/notmuch-pick/notmuch-pick.el
@@ -276,6 +276,11 @@ Some useful entries are:
   (notmuch-pick-get-prop :match))
 
 (defun notmuch-pick-refresh-result ()
+  "Redisplay the current message line.
+
+This redisplays the current line based on the messages
+properties (as they are now). This is used when tags are
+updated."
   (let ((init-point (point))
 	(end (line-end-position))
 	(msg (notmuch-pick-get-message-properties))
-- 
1.7.9.1

[PATCH 3/4] pick: contrib: document notmuch-pick-message-window-kill-hook

[Mark Walters]

---
 contrib/notmuch-pick/notmuch-pick.el |    1 +
 1 files changed, 1 insertions(+), 0 deletions(-)

diff --git a/contrib/notmuch-pick/notmuch-pick.el b/contrib/notmuch-pick/notmuch-pick.el
index 50686f0..fd68fc6 100644
--- a/contrib/notmuch-pick/notmuch-pick.el
+++ b/contrib/notmuch-pick/notmuch-pick.el
@@ -384,6 +384,7 @@ Does NOT change the database."
 		t))
 
 (defun notmuch-pick-message-window-kill-hook ()
+  "Close the message pane when exiting the show buffer."
   (let ((buffer (current-buffer)))
     (when (and (window-live-p notmuch-pick-message-window)
 	       (eq (window-buffer notmuch-pick-message-window) buffer))
-- 
1.7.9.1

[PATCH 4/4] contrib: pick: document several of the tree/forest insertion functions.

[Mark Walters]

---
 contrib/notmuch-pick/notmuch-pick.el |   12 ++++++++++--
 1 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/contrib/notmuch-pick/notmuch-pick.el b/contrib/notmuch-pick/notmuch-pick.el
index fd68fc6..fbd7c0b 100644
--- a/contrib/notmuch-pick/notmuch-pick.el
+++ b/contrib/notmuch-pick/notmuch-pick.el
@@ -683,7 +683,10 @@ unchanged ADDRESS if parsing fails."
 	(notmuch-pick-show-message)))))
 
 (defun notmuch-pick-insert-tree (tree depth tree-status first last)
-  "Insert the message tree TREE at depth DEPTH in the current thread."
+  "Insert the message tree TREE at depth DEPTH in the current thread.
+
+A message tree is another name for a single sub-thread: i.e., a
+message together with all its descendents."
   (let ((msg (car tree))
 	(replies (cadr tree)))
 
@@ -714,7 +717,7 @@ unchanged ADDRESS if parsing fails."
     (notmuch-pick-insert-thread replies (1+ depth) tree-status)))
 
 (defun notmuch-pick-insert-thread (thread depth tree-status)
-  "Insert the thread THREAD at depth DEPTH >= 1 in the current forest."
+  "Insert the collection of sibling sub-threads THREAD at depth DEPTH in the current forest."
   (let ((n (length thread)))
     (loop for tree in thread
 	  for count from 1 to n
@@ -722,12 +725,17 @@ unchanged ADDRESS if parsing fails."
 	  do (notmuch-pick-insert-tree tree depth tree-status (eq count 1) (eq count n)))))
 
 (defun notmuch-pick-insert-forest-thread (forest-thread)
+  "Insert a single complete thread."
   (let (tree-status)
     ;; Reset at the start of each main thread.
     (setq notmuch-pick-previous-subject nil)
     (notmuch-pick-insert-thread forest-thread 0 tree-status)))
 
 (defun notmuch-pick-insert-forest (forest)
+  "Insert a forest of threads.
+
+This function inserts a collection of several complete threads as
+passed to it by notmuch-pick-process-filter."
   (mapc 'notmuch-pick-insert-forest-thread forest))
 
 (defun notmuch-pick-mode ()
-- 
1.7.9.1

Re: [PATCH 0/4] contrib: pick: add docstrings to several functions

[David Bremner]

Mark Walters <markwalters1009@gmail.com> writes:

> This series adds docstrings to several previously undocumented
> functions in notmuch-pick. It is probably independent of the previous
> series id:1372665243-7675-1-git-send-email-markwalters1009@gmail.com
> but I haven't checked that so safest to apply on top of 

Pushed,

d