[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: debbugs-0.10: doc fixes
From: |
Tino Calancha |
Subject: |
Re: debbugs-0.10: doc fixes |
Date: |
Fri, 23 Sep 2016 16:42:26 +0900 (JST) |
User-agent: |
Alpine 2.20 (DEB 67 2015-01-07) |
On Tue, 13 Sep 2016, Michael Albinus wrote:
I've pushed this to the elpa repository, you might play with it. Within
a week or so, I will release debbugs 0.11.
Hi Michal,
it looks good. Thank you.
I have few suggestions to make the doc strings more clear. See below.
From 6d3d28162e0b3e956a531dd60380243cc5dfd481 Mon Sep 17 00:00:00 2001
From: Tino Calancha <address@hidden>
Date: Fri, 23 Sep 2016 16:37:01 +0900
Subject: [PATCH] debbugs-gnu.el: Doc fixes
* packages/debbugs/debbugs-gnu.el (debbugs-gnu-expand-bug-number-list):
Fix typo in doc string.
(debbugs-gnu-default-bug-number-list): Explain the meaning of a
value like '-N'.
(debbugs-gnu-bugs): Clarify in doc string the input format
for interactive calls.
Show default value in the prompt, i.e.,
'debbugs-gnu-default-bug-number-list'.
---
packages/debbugs/debbugs-gnu.el | 13 +++++++++----
1 file changed, 9 insertions(+), 4 deletions(-)
diff --git a/packages/debbugs/debbugs-gnu.el
b/packages/debbugs/debbugs-gnu.el
index 4a69f2b..f8b8726 100644
--- a/packages/debbugs/debbugs-gnu.el
+++ b/packages/debbugs/debbugs-gnu.el
@@ -1421,7 +1421,7 @@ MERGED is the list of bugs merged with this one."
"Dynamic completion table for reading bug numbers.")
(defun debbugs-gnu-expand-bug-number-list (bug-number-list)
- "Expand BUG-NUMBER-LIST to a list of singe bug numbers.
+ "Expand BUG-NUMBER-LIST to a list of single bug numbers.
BUG-NUMBER-LIST is a list of bug numbers or bug number ranges, as
returned by `debbugs-gnu-bugs'."
(let (result)
@@ -1659,20 +1659,25 @@ The following commands are available:
(defcustom debbugs-gnu-default-bug-number-list "-10"
"The default value used in interactive call of `debbugs-gnu-bugs'.
-It must be a string, containing a comma separated list of bugs or bug
ranges."
+It must be a string, containing a comma separated list of bugs or bug
ranges.
+A negative value, -N, means the newest N bugs."
:group 'debbugs-gnu
:type 'string
:version "25.2")
;;;###autoload
(defun debbugs-gnu-bugs (&rest bugs)
- "List all BUGS, a list of bug numbers."
+ "List all BUGS, a list of bug numbers.
+In interactive calls, prompt for a comma separated list of bugs
+or bug ranges, with default to `debbugs-gnu-default-bug-number-list'."
(interactive
(mapcar
'string-to-number
(debbugs-gnu-expand-bug-number-list
(or
- (completing-read-multiple "Bug numbers: "
debbugs-gnu-completion-table)
+ (completing-read-multiple
+ (format "Bug numbers (%s): " debbugs-gnu-default-bug-number-list)
+ debbugs-gnu-completion-table)
(split-string debbugs-gnu-default-bug-number-list "," t)))))
(dolist (elt bugs)
(unless (natnump elt) (signal 'wrong-type-argument (list 'natnump
elt))))
--
2.9.3
Repository revision: 1c1ee85d183daee1d409413226ec739f35499918