[PATCH 8/9] review: Rename variables to better express intention

Subject: [PATCH 8/9] review: Rename variables to better express intention

Date: Sun, 7 Aug 2022 15:57:32 +0100

To: David Bremner, notmuch@notmuchmail.org

Cc: Mohsin Kaleem

From: Mohsin Kaleem

---
 emacs/notmuch-hello.el | 18 +++++++++---------
 emacs/notmuch-jump.el  |  2 +-
 emacs/notmuch-lib.el   |  4 ++--
 emacs/notmuch-tree.el  | 24 ++++++++++++------------
 emacs/notmuch.el       | 29 +++++++++++++++--------------
 5 files changed, 39 insertions(+), 38 deletions(-)

diff --git a/emacs/notmuch-hello.el b/emacs/notmuch-hello.el
index 810f094e..39ba2537 100644
--- a/emacs/notmuch-hello.el
+++ b/emacs/notmuch-hello.el
@@ -143,10 +143,10 @@ a plist. Supported properties are
   :sort-order      Specify the sort order to be used for the search.
                    Possible values are `oldest-first', `newest-first'
                    or nil. Nil means use the default sort order.
-  :excluded        Whether to include mail with excluded tags in the
-                   search. Possible values are `include', `exclude',
+  :excluded        Whether to show mail with excluded tags in the
+                   search. Possible values are `hide', `show',
                    or nil. Nil means use the default value of
-                   `notmuch-search-exclude'.
+                   `notmuch-search-hide-excluded'.
   :search-type     Specify whether to run the search in search-mode,
                    tree mode or unthreaded mode. Set to `tree' to
                    specify tree mode, 'unthreaded to specify
@@ -490,7 +490,7 @@ diagonal."
 (defun notmuch-hello-widget-search (widget &rest _ignore)
   (let ((search-terms (widget-get widget :notmuch-search-terms))
 	(oldest-first (widget-get widget :notmuch-search-oldest-first))
-	(exclude (widget-get widget :notmuch-search-exclude)))
+	(exclude (widget-get widget :notmuch-search-hide-excluded)))
     (cl-case (widget-get widget :notmuch-search-type)
       (tree
        (let ((n (notmuch-search-format-buffer-name (widget-value widget) "tree" t)))
@@ -498,7 +498,7 @@ diagonal."
       (unthreaded
        (let ((n (notmuch-search-format-buffer-name (widget-value widget)
 						   "unthreaded" t)))
-	 (notmuch-unthreaded search-terms nil nil n nil oldest-first search-exclude)))
+	 (notmuch-unthreaded search-terms nil nil n nil oldest-first exclude)))
       (t
        (notmuch-search search-terms oldest-first exclude)))))
 
@@ -648,9 +648,9 @@ with `notmuch-hello-query-counts'."
 				     (oldest-first t)
 				     (otherwise notmuch-search-oldest-first)))
 		     (exclude (cl-case (plist-get elem :excluded)
-				(exclude t)
-				(include nil)
-				(otherwise notmuch-search-exclude)))
+				(hide t)
+				(show nil)
+				(otherwise notmuch-search-hide-excluded)))
 		     (search-type (plist-get elem :search-type))
 		     (msg-count (plist-get elem :count)))
 		(widget-insert (format "%8s "
@@ -660,7 +660,7 @@ with `notmuch-hello-query-counts'."
 			       :notmuch-search-terms query
 			       :notmuch-search-oldest-first oldest-first
 			       :notmuch-search-type search-type
-			       :notmuch-search-exclude exclude
+			       :notmuch-search-hide-excluded exclude
 			       name)
 		(setq column-indent
 		      (1+ (max 0 (- column-width (length name)))))))
diff --git a/emacs/notmuch-jump.el b/emacs/notmuch-jump.el
index e98c9c1d..53496e5c 100644
--- a/emacs/notmuch-jump.el
+++ b/emacs/notmuch-jump.el
@@ -51,7 +51,7 @@ fast way to jump to a saved search from anywhere in Notmuch."
 		   (newest-first nil)
 		   (oldest-first t)
 		   (otherwise (default-value 'notmuch-search-oldest-first))))
-		(exclude (default-value 'notmuch-search-exclude)))
+		(exclude (default-value 'notmuch-search-hide-excluded)))
 	    (push (list key name
 			(cond
 			 ((eq (plist-get saved-search :search-type) 'tree)
diff --git a/emacs/notmuch-lib.el b/emacs/notmuch-lib.el
index 96795054..d0205d0e 100644
--- a/emacs/notmuch-lib.el
+++ b/emacs/notmuch-lib.el
@@ -105,7 +105,7 @@ search."
   :group 'notmuch-search)
 (make-variable-buffer-local 'notmuch-search-oldest-first)
 
-(defcustom notmuch-search-exclude t
+(defcustom notmuch-search-hide-excluded t
   "Hide mail tagged with a excluded tag.
 
 Excluded tags are defined in the users configuration file under
@@ -113,7 +113,7 @@ the search section. When this variable is true, any mail with
 such a tag will not be shown in the search output."
   :type 'boolean
   :group 'notmuch-search)
-(make-variable-buffer-local 'notmuch-search-exclude)
+(make-variable-buffer-local 'notmuch-search-hide-excluded)
 
 (defcustom notmuch-poll-script nil
   "[Deprecated] Command to run to incorporate new mail into the notmuch database.
diff --git a/emacs/notmuch-tree.el b/emacs/notmuch-tree.el
index 5f999424..6d19b9ed 100644
--- a/emacs/notmuch-tree.el
+++ b/emacs/notmuch-tree.el
@@ -593,7 +593,7 @@ NOT change the database."
   (notmuch-tree-close-message-window)
   (notmuch-search (notmuch-tree-get-query)
 		  notmuch-search-oldest-first
-		  notmuch-search-exclude))
+		  notmuch-search-hide-excluded))
 
 (defun notmuch-tree-message-window-kill-hook ()
   "Close the message pane when exiting the show buffer."
@@ -807,7 +807,7 @@ nil otherwise."
 			 nil
 			 unthreaded
 			 notmuch-search-oldest-first
-			 notmuch-search-exclude)))
+			 notmuch-search-hide-excluded)))
 
 (defun notmuch-tree-thread-top ()
   (when (notmuch-tree-get-message-properties)
@@ -1134,7 +1134,7 @@ the same as for the function notmuch-tree."
   (notmuch-tree-mode)
   (add-hook 'post-command-hook #'notmuch-tree-command-hook t t)
   (setq notmuch-search-oldest-first oldest-first)
-  (setq notmuch-search-exclude exclude)
+  (setq notmuch-search-hide-excluded exclude)
   (setq notmuch-tree-unthreaded unthreaded)
   (setq notmuch-tree-basic-query basic-query)
   (setq notmuch-tree-query-context (if (or (string= query-context "")
@@ -1193,14 +1193,14 @@ default sort order is defined by `notmuch-search-oldest-first'."
   "Toggle whether to hide excluded messages.
 
 This command toggles whether to hide excluded messages for the current
-search. The default value for this is defined by `notmuch-search-exclude'."
+search. The default value for this is defined by `notmuch-search-hide-excluded'."
   (interactive)
-  (setq notmuch-search-exclude (not notmuch-search-exclude))
+  (setq notmuch-search-hide-excluded (not notmuch-search-hide-excluded))
   (notmuch-tree-refresh-view))
 
 (defun notmuch-tree (&optional query query-context target buffer-name
 			       open-target unthreaded parent-buffer
-			       oldest-first exclude)
+			       oldest-first hide-excluded)
   "Display threads matching QUERY in tree view.
 
 The arguments are:
@@ -1223,7 +1223,7 @@ The arguments are:
     nil nil nil nil nil nil
     ;; Populate these from the default value of these options.
     (default-value 'notmuch-search-oldest-first)
-    (default-value 'notmuch-search-exclude)))
+    (default-value 'notmuch-search-hide-excluded)))
   (unless query
     (setq query (notmuch-read-query (concat "Notmuch "
 					    (if unthreaded "unthreaded " "tree ")
@@ -1238,12 +1238,12 @@ The arguments are:
   ;; Don't track undo information for this buffer
   (setq buffer-undo-list t)
   (notmuch-tree-worker query query-context target open-target
-		       unthreaded oldest-first exclude)
+		       unthreaded oldest-first hide-excluded)
   (setq notmuch-tree-parent-buffer parent-buffer)
   (setq truncate-lines t))
 
 (defun notmuch-unthreaded (&optional query query-context target buffer-name
-				     open-target oldest-first exclude)
+				     open-target oldest-first hide-excluded)
   "Display threads matching QUERY in unthreaded view.
 
 See function NOTMUCH-TREE for documentation of the arguments"
@@ -1255,9 +1255,9 @@ See function NOTMUCH-TREE for documentation of the arguments"
     nil nil nil nil
     ;; Populate these from the default value of these options.
     (default-value 'notmuch-search-oldest-first)
-    (default-value 'notmuch-search-exclude)))
+    (default-value 'notmuch-search-hide-excluded)))
   (notmuch-tree query query-context target buffer-name open-target
-		t nil oldest-first exclude))
+		t nil oldest-first hide-excluded))
 
 (defun notmuch-tree-filter (query)
   "Filter or LIMIT the current search results based on an additional query string.
@@ -1292,7 +1292,7 @@ search results and that are also tagged with the given TAG."
 		  notmuch-tree-unthreaded
 		  nil
 		  notmuch-search-oldest-first
-		  notmuch-search-exclude)))
+		  notmuch-search-hide-excluded)))
 
 ;;; _
 
diff --git a/emacs/notmuch.el b/emacs/notmuch.el
index 0158e20a..8dee623b 100644
--- a/emacs/notmuch.el
+++ b/emacs/notmuch.el
@@ -553,7 +553,7 @@ Return non-nil on success."
   (notmuch-tree notmuch-search-query-string
 		nil nil nil nil nil nil
 		notmuch-search-oldest-first
-		notmuch-search-exclude))
+		notmuch-search-hide-excluded))
 
 (defun notmuch-unthreaded-from-search-current-query ()
   "Unthreaded view of current query."
@@ -561,7 +561,7 @@ Return non-nil on success."
   (notmuch-unthreaded notmuch-search-query-string
 		      nil nil nil nil
 		      notmuch-search-oldest-first
-		      notmuch-search-exclude))
+		      notmuch-search-hide-excluded))
 
 (defun notmuch-tree-from-search-thread ()
   "Show the selected thread with notmuch-tree."
@@ -572,7 +572,7 @@ Return non-nil on success."
 		(notmuch-prettify-subject (notmuch-search-find-subject))
 		t nil (current-buffer)
 		notmuch-search-oldest-first
-		notmuch-search-exclude))
+		notmuch-search-hide-excluded))
 
 (defun notmuch-search-reply-to-thread (&optional prompt-for-sender)
   "Begin composing a reply-all to the entire current thread in a new buffer."
@@ -1042,7 +1042,7 @@ PROMPT is the string to prompt with."
 
 (put 'notmuch-search 'notmuch-doc "Search for messages.")
 ;;;###autoload
-(defun notmuch-search (&optional query oldest-first exclude target-thread
+(defun notmuch-search (&optional query oldest-first hide-excluded target-thread
 				 target-line no-display)
   "Display threads matching QUERY in a notmuch-search buffer.
 
@@ -1050,7 +1050,8 @@ If QUERY is nil, it is read interactively from the minibuffer.
 Other optional parameters are used as follows:
 
   OLDEST-FIRST: A Boolean controlling the sort order of returned threads
-  EXCLUDE: A boolean controlling whether to omit threads with excluded tags.
+  HIDE-EXCLUDED: A boolean controlling whether to omit threads with excluded
+                 tags.
   TARGET-THREAD: A thread ID (without the thread: prefix) that will be made
                  current if it appears in the search results.
   TARGET-LINE: The line number to move to if the target thread does not
@@ -1068,7 +1069,7 @@ the configured default sort order."
     ;; Use the default search order and exclude value (if we're doing a
     ;; search from a search buffer, ignore any buffer-local overrides)
     (default-value 'notmuch-search-oldest-first)
-    (default-value 'notmuch-search-exclude)))
+    (default-value 'notmuch-search-hide-excluded)))
 
   (let* ((query (or query (notmuch-read-query "Notmuch search: ")))
 	 (buffer (get-buffer-create (notmuch-search-buffer-title query))))
@@ -1082,7 +1083,7 @@ the configured default sort order."
     (setq notmuch-search-oldest-first oldest-first)
     (setq notmuch-search-target-thread target-thread)
     (setq notmuch-search-target-line target-line)
-    (setq notmuch-search-exclude exclude)
+    (setq notmuch-search-hide-excluded hide-excluded)
     (notmuch-tag-clear-cache)
     (when (get-buffer-process buffer)
       (error "notmuch search process already running for query `%s'" query))
@@ -1096,7 +1097,7 @@ the configured default sort order."
 		     (if oldest-first
 			 "--sort=oldest-first"
 		       "--sort=newest-first")
-		     (if exclude
+		     (if hide-excluded
 			 "--exclude=true"
 		       "--exclude=false")
 		     query)))
@@ -1119,7 +1120,7 @@ same relative position within the new buffer."
   (interactive)
   (notmuch-search notmuch-search-query-string
 		  notmuch-search-oldest-first
-		  notmuch-search-exclude
+		  notmuch-search-hide-excluded
 		  (notmuch-search-find-thread-id 'bare)
 		  (line-number-at-pos)
 		  t)
@@ -1129,9 +1130,9 @@ same relative position within the new buffer."
   "Toggle whether to hide excluded messages.
 
 This command toggles whether to hide excluded messages for the current
-search. The default value for this is defined by `notmuch-search-exclude'."
+search. The default value for this is defined by `notmuch-search-hide-excluded'."
   (interactive)
-  (setq notmuch-search-exclude (not notmuch-search-exclude))
+  (setq notmuch-search-hide-excluded (not notmuch-search-hide-excluded))
   (notmuch-search-refresh-view))
 
 (defun notmuch-search-toggle-order ()
@@ -1163,7 +1164,7 @@ current search results AND the additional query string provided."
 			grouped-query
 		      (concat grouped-original-query " and " grouped-query))
 		    notmuch-search-oldest-first
-		    notmuch-search-exclude)))
+		    notmuch-search-hide-excluded)))
 
 (defun notmuch-search-filter-by-tag (tag)
   "Filter the current search results based on a single TAG.
@@ -1175,7 +1176,7 @@ search results and that are also tagged with the given TAG."
 					     notmuch-search-query-string)))
   (notmuch-search (concat notmuch-search-query-string " and tag:" tag)
 		  notmuch-search-oldest-first
-		  notmuch-search-exclude))
+		  notmuch-search-hide-excluded))
 
 (defun notmuch-search-by-tag (tag)
   "Display threads matching TAG in a notmuch-search buffer."
@@ -1183,7 +1184,7 @@ search results and that are also tagged with the given TAG."
    (list (notmuch-select-tag-with-completion "Notmuch search tag: ")))
   (notmuch-search (concat "tag:" tag)
 		  (default-value 'notmuch-search-oldest-first)
-		  (default-value 'notmuch-search-exclude)))
+		  (default-value 'notmuch-search-hide-excluded)))
 
 ;;;###autoload
 (defun notmuch ()
-- 
2.37.1

_______________________________________________
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-leave@notmuchmail.org

Thread: