emacs-pretest-bug
[Top][All Lists]
Advanced

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

RE: doc for catch & throw should not mention "tag"


From: Drew Adams
Subject: RE: doc for catch & throw should not mention "tag"
Date: Sat, 29 Apr 2006 15:19:38 -0700

       The doc strings and the Emacs Lisp-manual doc for `catch' and `throw'
       currently refer to the catch target as the "tag".  Because
       of possible
       confusion with tags files, and to let searching the manual
       for "\btag"
       find only occurrences that involve tag files, the doc for `catch' and
       `throw' should call the target something like "target" or "label"
       instead of "tag".

    "tag" is just standard Lisp terminology for this.  That is why, for
    instance, the Common Lisp function `tagbody' is not called `labelbody'
    or `targetbody'.

Yes, I know that. But I don't think Common Lisp has tags tables. The Emacs
"Tags facility" is well known.

Anyway, here are some more comments. Take them for what you will...

-------

It turns out that there is anyway almost no mention of tags tables (or
files) in the Emacs-Lisp manual. So my suggestion about that manual is
perhaps irrelevant.

In the Emacs manual, however, "tag" refers mainly to tags tables (the "Tags
facility") - that is what users will think a "tag" is. So I still think it's
a bad idea to use "tag" for just about anything in the Lisp manual. For
example:

1. It's too bad we also have keyword ":tag". That keyword should perhaps
have been called ":label" (that's what it is), but it's too late for that
now. This is the most frequent occurrence of "tag" in the Emacs-Lisp manual,
BTW.

2. Manual node Bindat Spec could avoid using "tag" in `union FORM (TAG
SPEC)...'. Here, the word means nothing - the TAG is similar to the FORM.
Some better term should be found.


Back to the Emacs manual -

1. It looks like Tumme has now introduced yet another meaning for "tag" -
see node Tumme. At least this meaning is a bit similar to the tags-table
notion. However, this similarity can be an even worse source of confusion,
especially since Tumme speaks of "tagged" files. It would be better to pick
a better term for this - the Tumme doc itself suggests alternatives: ""Tag"
is just another word for "keyword", "label" or "category"." I'd suggest
using "category" or perhaps "property".

2. Node Init Syntax refers to "a `-*-coding: CODING-SYSTEM-*-' tag on the
first line". This should be called a "declaration", not a "tag".






reply via email to

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