[Top][All Lists]

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

Re: doc elisp intro cross reference fixes

From: Per Abrahamsen
Subject: Re: doc elisp intro cross reference fixes
Date: Thu, 27 Nov 2003 12:10:58 +0100
User-agent: Gnus/5.1003 (Gnus v5.10.3) Emacs/21.3 (gnu/linux)

Juri Linkov <address@hidden> writes:

> I suppose that there is such implicit convention already exists that
> internal variables should have no docstrings.  Is it true?

It used to be true back when doc-strings were dumped into the
executable and memory was scarce.  

But I believe doc-strings for internal variables and functions are
considered acceptable these days.

There are a couple of naming conventions sporadically used by
functions, like adding "-1" to the name of helper functions, or adding
"internal" to the name of the function.

reply via email to

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