[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: tumme testing

From: Robert J. Chassell
Subject: Re: tumme testing
Date: Sat, 11 Feb 2006 12:57:59 +0000 (UTC)

   > I didn't even know about a database file.  That should be mentioned in
   > the functions document string so describe-function displays it.  (I
   > had not read the documentation in the Emacs manual.)

   Would all "tag commands" need that info? Although there are quite few
   of them now, more could be added, and I hate redundant documentation.

Please remember, not every one will have read the manual.  Or if they
have, they may not remember it.  

Perhaps they last read the relevant node 20 years ago.  If you do as
well as others, and you should, people for whom Chinese is a second
language will read a translation of your words in 2026.

The doc string and the Texinfo documentation are not redundant; the
purposes of each are different.

As an example, please look at the dired documentation:
`describe-function' provides a long description, not only saying on
one line

    "Edit" directory DIRNAME--delete, rename, print, etc. some files in it.

but also listing some of its commands on additional lines.  

Think of the purpose of this documentation.  Then compare it to the
documentation in Texinfo.

Like the `describe-function' documentation, the (emacs)Dired node also
says that dired is a directory editor.  However, it explains what that
means in different words than `describe-function'.  It takes a

In addition, that Info node contains 15 other nodes that describe
matters such as navigation and deletion.  And that number does not
count the two nodes `wdired' and `tumme'.

Each tag command requires documentation that `describe-function'
displays and, in different and when necessary more words, the Texinfo
file requires documentation, too.

   >     To tag
   >     image files, mark them in the dired buffer and type `C-t t'
   >     (`tumme-tag-files').  To mark files having a certain tag, type `C-t f'
   >     (`tumme-mark-tagged-files').

   Sorry, I really tried to understand what you mean above, but it seems
   I am the sleepy one right now. Could you maybe suggest a change of the
   manual (which, btw, is not done yet).

You simply want to say something like the following (in one filled
paragraph; but at the moment, there is no command to view the image
files as small thumbnails in dired, I am leaving the commands as
ellipses and the paragraph unfilled):

    The viewing commands are the same as before.
    To view those image files as small thumbnails in dired, type ...
    To view those image files as thumbnails in a different buffer,
    type ...

    Robert J. Chassell                         
    address@hidden                         GnuPG Key ID: 004B4AC8
    http://www.rattlesnake.com                  http://www.teak.cc

reply via email to

[Prev in Thread] Current Thread [Next in Thread]