unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Paul Eggert <eggert@cs.ucla.edu>
To: Glenn Morris <rgm@gnu.org>, emacs-devel@gnu.org
Subject: Re: master b342815: Improve define-function omitted-arg documentation
Date: Fri, 27 May 2016 10:52:00 -0700	[thread overview]
Message-ID: <a2fc9113-bb6d-62e4-ce12-0922e1b6081c@cs.ucla.edu> (raw)
In-Reply-To: <27d1o7ph7e.fsf@fencepost.gnu.org>

On 05/27/2016 10:02 AM, Glenn Morris wrote:
>
>> IMO all the stuff about t is an internal implementation detail that has
>> no place in the documentation.
> Ach, blast, I see it was mentioned briefly before.

Yes, and I'm afraid the topic needs to be covered in the documentation. 
I was confused by the old, terser doc, and Eli was I think right in 
suggesting that define-function's atypical design be covered more clearly.

Alternatively, I suppose we could improve define-function's design....


 > Prejudiced against Fortran, are we?

Guilty as charged. :-) Though there were other reasons for that part of 
the change: the old Fortrannish documentation mentioned gud-find-c-expr, 
a function that is no longer in GNU Emacs. Plus, the old doc had a 
complicated song-and-dance about hooks, whereas the new simple.el 
example is, well, simpler.

 > We previously decided against doing this: http://debbugs.gnu.org/8646

Sorry, I wasn't aware of that old decision. I made the change because of 
a more-recent statement by the current maintainer that we should strive 
to eliminate warnings rather than continue to live with the current 
chatter, which too often leads developers to ignore warnings. See:

https://lists.gnu.org/archive/html/bug-gnu-emacs/2015-11/msg00902.html




  reply	other threads:[~2016-05-27 17:52 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20160527164722.20278.19217@vcs.savannah.gnu.org>
     [not found] ` <20160527164723.4A992220156@vcs.savannah.gnu.org>
2016-05-27 16:58   ` master b342815: Improve define-function omitted-arg documentation Glenn Morris
2016-05-27 17:02     ` Glenn Morris
2016-05-27 17:52       ` Paul Eggert [this message]
2016-05-27 18:51       ` Eli Zaretskii
2016-05-27 19:48   ` Stefan Monnier
2016-05-28  1:19     ` Paul Eggert

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=a2fc9113-bb6d-62e4-ce12-0922e1b6081c@cs.ucla.edu \
    --to=eggert@cs.ucla.edu \
    --cc=emacs-devel@gnu.org \
    --cc=rgm@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).