From: "Jim Blandy" <jimb@red-bean.com>
To: "Lennart Borgman (gmail)" <lennart.borgman@gmail.com>
Cc: raman@users.sf.net, emacs-devel@gnu.org
Subject: Re: proced-refine: confusing doc string
Date: Sun, 28 Sep 2008 23:27:11 -0700 [thread overview]
Message-ID: <8f2776cb0809282327o701b7ba1y6953826a5117a99a@mail.gmail.com> (raw)
In-Reply-To: <48DFDF4F.5080704@gmail.com>
[-- Attachment #1: Type: text/plain, Size: 941 bytes --]
On Sun, Sep 28, 2008 at 12:47 PM, Lennart Borgman (gmail)
<lennart.borgman@gmail.com> wrote:
> T. V. Raman wrote:
>> The proced-refine command has the following as part of its doc
>> string:
>>
>> <cite>
>> If point is on the attribute ATTR, this command compares the value of ATTR
>> of every process with the value of ATTR of the process at the position
>> of point. One can select processes for which the value of ATTR is
>> \"less than\", \"equal\", and / or \"larger\" than ATTR of the process
>> point is on.
>>
>> </cite>
>>
>> The initial sentence talks about point being in the header, the
>> latter half talks about the process that point is on. How can
>> point be in both places at once?
>
> Doesn't it mean the column ATTR (or however it is layed out, I do not know)?
It does --- but Raman is certainly not the only user reading it that
way. Should the docstring be more explicit? Attached is what would
make sense to me.
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: jimb.proced-refine-doc.patch --]
[-- Type: text/x-diff; name=jimb.proced-refine-doc.patch, Size: 2037 bytes --]
It seems like there's no need to repeat details of proced-refine's
behavior in the proced-mode docstring.
The 'proced-refine' docstring should be clearer about exactly where
point needs to be.
The phrase 'at the position of point' is redundant; Emacs
documentation simply says, 'at point'.
2008-09-29 Jim Blandy <jimb@red-bean.com>
* proced.el (proced-mode, proced-refine): Doc fixes.
diff --git a/lisp/proced.el b/lisp/proced.el
--- a/lisp/proced.el
+++ b/lisp/proced.el
@@ -551,11 +551,9 @@ to change the sort scheme. The current
to change the sort scheme. The current sort scheme is indicated in the
mode line, using \"+\" or \"-\" for ascending or descending sort order.
-An existing Proced listing can be refined by typing \\[proced-refine]
-with point on the attribute of a process. If point is on the attribute ATTR,
-this compares the value of ATTR of every process with the value of ATTR
-of the process at the position of point. See `proced-refine' for details.
-Refining an existing listing does not update the variable `proced-filter'.
+You can drop processes from the list based on their attribute
+values by typing \\[proced-refine]. See `proced-refine' for
+details.
The attribute-specific rules for formatting, filtering, sorting, and refining
are defined in `proced-grammar-alist'.
@@ -884,9 +882,9 @@ This list includes CPID unless OMIT-CPID
"Refine Proced listing by comparing with the attribute value at point.
Optional EVENT is the location of the Proced field.
-If point is on the attribute ATTR, this command compares the value of ATTR
-of every process with the value of ATTR of the process at the position
-of point. One can select processes for which the value of ATTR is
+If point is on a process's value for the attribute ATTR, this command compares the value of ATTR
+of every process with the value of ATTR of the process at
+point. One can select processes for which the value of ATTR is
\"less than\", \"equal\", and / or \"larger\" than ATTR of the process
point is on.
next prev parent reply other threads:[~2008-09-29 6:27 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2008-09-28 19:41 proced-refine: confusing doc string T. V. Raman
2008-09-28 19:47 ` Lennart Borgman (gmail)
2008-09-29 6:27 ` Jim Blandy [this message]
2008-09-30 2:30 ` T. V. Raman
2008-09-30 17:46 ` Jim Blandy
2008-10-01 3:01 ` T. V. Raman
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=8f2776cb0809282327o701b7ba1y6953826a5117a99a@mail.gmail.com \
--to=jimb@red-bean.com \
--cc=emacs-devel@gnu.org \
--cc=lennart.borgman@gmail.com \
--cc=raman@users.sf.net \
/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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.