From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Richard Stallman Newsgroups: gmane.emacs.devel Subject: Re: CL function's docstrings Date: Wed, 18 May 2005 01:20:42 -0400 Message-ID: References: Reply-To: rms@gnu.org NNTP-Posting-Host: main.gmane.org X-Trace: sea.gmane.org 1116425903 21139 80.91.229.2 (18 May 2005 14:18:23 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Wed, 18 May 2005 14:18:23 +0000 (UTC) Cc: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Wed May 18 16:18:19 2005 Return-path: Original-Received: from lists.gnu.org ([199.232.76.165]) by ciao.gmane.org with esmtp (Exim 4.43) id 1DYPKM-0001R3-CM for ged-emacs-devel@m.gmane.org; Wed, 18 May 2005 16:15:14 +0200 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1DYPMo-0003t0-3V for ged-emacs-devel@m.gmane.org; Wed, 18 May 2005 10:17:46 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1DYHMN-0006js-4n for emacs-devel@gnu.org; Wed, 18 May 2005 01:44:47 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1DYHMM-0006jV-HZ for emacs-devel@gnu.org; Wed, 18 May 2005 01:44:46 -0400 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1DYHKs-0005e4-C1 for emacs-devel@gnu.org; Wed, 18 May 2005 01:43:14 -0400 Original-Received: from [199.232.76.164] (helo=fencepost.gnu.org) by monty-python.gnu.org with esmtp (Exim 4.34) id 1DYH7T-0003Bz-Rw for emacs-devel@gnu.org; Wed, 18 May 2005 01:29:23 -0400 Original-Received: from rms by fencepost.gnu.org with local (Exim 4.34) id 1DYGz4-0003eu-1O; Wed, 18 May 2005 01:20:42 -0400 Original-To: Juanma Barranquero In-reply-to: (message from Juanma Barranquero on Tue, 17 May 2005 01:52:06 +0200) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:37257 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:37257 2) Change the argument names to match the docstrings. Pros: it is the cleaner way. Cons: lot of change in the cl* files; less coherence between argument names among functions. 3) Change the docstrings to match the argument names. Pro: easy. Cons: names are often much less descriptive than the ones already existing. For each function, it is possible to change the argument names, the doc string, or both. How about if you do whatever is best so as to use the best possible names in each function?