From: Richard Stallman <rms@gnu.org>
Cc: emacs-devel@gnu.org
Subject: Re: CL function's docstrings
Date: Wed, 18 May 2005 01:20:42 -0400 [thread overview]
Message-ID: <E1DYGz4-0003eu-1O@fencepost.gnu.org> (raw)
In-Reply-To: <f7ccd24b0505161652363001eb@mail.gmail.com> (message from Juanma Barranquero on Tue, 17 May 2005 01:52:06 +0200)
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?
next prev parent reply other threads:[~2005-05-18 5:20 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2005-05-16 23:52 CL function's docstrings Juanma Barranquero
2005-05-17 21:15 ` Stefan Monnier
2005-05-18 12:13 ` Kim F. Storm
2005-05-18 12:50 ` Juanma Barranquero
2005-05-18 22:45 ` Richard Stallman
2005-05-19 13:04 ` Stefan Monnier
2005-05-18 5:20 ` Richard Stallman [this message]
2005-05-18 8:09 ` Juanma Barranquero
2005-05-19 6:48 ` Richard Stallman
2005-05-19 23:57 ` Juanma Barranquero
2005-05-21 4:47 ` Richard Stallman
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=E1DYGz4-0003eu-1O@fencepost.gnu.org \
--to=rms@gnu.org \
--cc=emacs-devel@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).