emacs-devel
[Top][All Lists]
Advanced

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

Re: new *Help* argument highlighting


From: Kenichi Handa
Subject: Re: new *Help* argument highlighting
Date: Wed, 12 May 2004 20:25:38 +0900 (JST)
User-agent: SEMI/1.14.3 (Ushinoya) FLIM/1.14.2 (Yagi-Nishiguchi) APEL/10.2 Emacs/21.3 (sparc-sun-solaris2.6) MULE/5.0 (SAKAKI)

In article <address@hidden>, Juanma Barranquero <address@hidden> writes:

> On Wed, 12 May 2004 19:47:58 +0900 (JST)
> Kenichi Handa <address@hidden> wrote:

>>  I prefer a shorter convention something like @NAME or $NAME.

> The probability of a collision with current docstrings is much higher.
> $NAME could happen easily in shell-related modules, and both in
> perl-related ones.

Really?  I think it's very rare that a docstring of a
funciton that has an argument NAME contains a reference to a
shell/perl variable NAME in the form $NAME?

I grepped "\$[a-z]" in etc/DOC but found none.

The reason I prefer a shorter name is that I want to keep
the first line of a docstring in a source code short because
we can't fill it.  And, if we use @var{NAME}, it's get a
little bit difficult to check if the first line fits in 80
columns.

---
Ken'ichi HANDA
address@hidden




reply via email to

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