From mboxrd@z Thu Jan 1 00:00:00 1970 Path: main.gmane.org!not-for-mail From: Per Abrahamsen Newsgroups: gmane.emacs.devel Subject: Re: doc elisp intro cross reference fixes Date: Thu, 27 Nov 2003 12:10:58 +0100 Organization: The Church of Emacs Sender: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Message-ID: References: <87wua28zux.fsf@zip.com.au> <87ad6vdsxi.fsf@mail.jurta.org> <87y8u2uv6l.fsf@mail.jurta.org> NNTP-Posting-Host: deer.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: sea.gmane.org 1069932249 32123 80.91.224.253 (27 Nov 2003 11:24:09 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Thu, 27 Nov 2003 11:24:09 +0000 (UTC) Original-X-From: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Thu Nov 27 12:24:06 2003 Return-path: Original-Received: from quimby.gnus.org ([80.91.224.244]) by deer.gmane.org with esmtp (Exim 3.35 #1 (Debian)) id 1APKFi-0000G4-00 for ; Thu, 27 Nov 2003 12:24:06 +0100 Original-Received: from monty-python.gnu.org ([199.232.76.173]) by quimby.gnus.org with esmtp (Exim 3.35 #1 (Debian)) id 1APKFi-0006Dm-00 for ; Thu, 27 Nov 2003 12:24:06 +0100 Original-Received: from localhost ([127.0.0.1] helo=monty-python.gnu.org) by monty-python.gnu.org with esmtp (Exim 4.24) id 1APLCZ-00060D-CA for emacs-devel@quimby.gnus.org; Thu, 27 Nov 2003 07:24:55 -0500 Original-Received: from list by monty-python.gnu.org with tmda-scanned (Exim 4.24) id 1APL2J-0001jB-Rk for emacs-devel@gnu.org; Thu, 27 Nov 2003 07:14:19 -0500 Original-Received: from mail by monty-python.gnu.org with spam-scanned (Exim 4.24) id 1APL1i-0001bZ-Ev for emacs-devel@gnu.org; Thu, 27 Nov 2003 07:14:13 -0500 Original-Received: from [80.91.224.249] (helo=main.gmane.org) by monty-python.gnu.org with esmtp (Exim 4.24) id 1APL0V-0001Iw-0X for emacs-devel@gnu.org; Thu, 27 Nov 2003 07:12:27 -0500 Original-Received: from list by main.gmane.org with local (Exim 3.35 #1 (Debian)) id 1APK33-0002Pi-00 for ; Thu, 27 Nov 2003 12:11:01 +0100 Mail-Followup-To: emacs-devel@gnu.org X-Injected-Via-Gmane: http://gmane.org/ Original-To: emacs-devel@gnu.org Original-Received: from sea.gmane.org ([80.91.224.252]) by main.gmane.org with esmtp (Exim 3.35 #1 (Debian)) id 1APK31-0002PS-00 for ; Thu, 27 Nov 2003 12:10:59 +0100 Original-Received: from news by sea.gmane.org with local (Exim 3.35 #1 (Debian)) id 1APK31-0007zh-00 for ; Thu, 27 Nov 2003 12:10:59 +0100 Original-Lines: 15 Original-X-Complaints-To: usenet@sea.gmane.org X-Face: +kRV2]2q}lixHkE{U)mY#+6]{AH=yN~S9@IFiOa@X6?GM|8MBp/ Mail-Copies-To: nobody User-Agent: Gnus/5.1003 (Gnus v5.10.3) Emacs/21.3 (gnu/linux) Cancel-Lock: sha1:o81hne/F74gXnJ+B1+3IVm/3Dg4= X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.2 Precedence: list List-Id: Emacs development discussions. List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Xref: main.gmane.org gmane.emacs.devel:18161 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:18161 Juri Linkov 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.