From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Josh Newsgroups: gmane.emacs.bugs Subject: bug#16959: 24.3.50; defadvice docstring out of date Date: Wed, 12 Mar 2014 09:30:08 -0700 Message-ID: References: <5319DEF8.3050809@miszellen.de> <531EA10D.20507@miszellen.de> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: multipart/alternative; boundary=20cf30563ed35f41cc04f46b5bed X-Trace: ger.gmane.org 1394641868 24726 80.91.229.3 (12 Mar 2014 16:31:08 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Wed, 12 Mar 2014 16:31:08 +0000 (UTC) Cc: Florian Beck , 16959@debbugs.gnu.org To: Stefan Monnier Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Wed Mar 12 17:31:16 2014 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1WNm3o-00042p-3q for geb-bug-gnu-emacs@m.gmane.org; Wed, 12 Mar 2014 17:31:16 +0100 Original-Received: from localhost ([::1]:33496 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WNm3n-000736-LF for geb-bug-gnu-emacs@m.gmane.org; Wed, 12 Mar 2014 12:31:15 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:50712) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WNm3f-0006tD-Dc for bug-gnu-emacs@gnu.org; Wed, 12 Mar 2014 12:31:12 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1WNm3a-0003bH-Ln for bug-gnu-emacs@gnu.org; Wed, 12 Mar 2014 12:31:07 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:33658) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WNm3a-0003b6-IV for bug-gnu-emacs@gnu.org; Wed, 12 Mar 2014 12:31:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.80) (envelope-from ) id 1WNm3Z-000492-Op for bug-gnu-emacs@gnu.org; Wed, 12 Mar 2014 12:31:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Josh Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 12 Mar 2014 16:31:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 16959 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 16959-submit@debbugs.gnu.org id=B16959.139464184515901 (code B ref 16959); Wed, 12 Mar 2014 16:31:01 +0000 Original-Received: (at 16959) by debbugs.gnu.org; 12 Mar 2014 16:30:45 +0000 Original-Received: from localhost ([127.0.0.1]:34840 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1WNm3H-00048I-EP for submit@debbugs.gnu.org; Wed, 12 Mar 2014 12:30:44 -0400 Original-Received: from mail-yk0-f175.google.com ([209.85.160.175]:53474) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1WNm3D-000487-0E for 16959@debbugs.gnu.org; Wed, 12 Mar 2014 12:30:40 -0400 Original-Received: by mail-yk0-f175.google.com with SMTP id 131so27714642ykp.6 for <16959@debbugs.gnu.org>; Wed, 12 Mar 2014 09:30:38 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:sender:in-reply-to:references:from :date:message-id:subject:to:cc:content-type; bh=jmn4xgVfpgVxsmkFi72V5hQ3FI/BwFwkgaS0LVhwcvs=; b=A8DzEPRRzKX+HYPYiCT0QJx7qYoWIhv3a9WPn+e12WRkV8uWsSa5KFeTdmSU9JiVco ugzkZGVug1HmBcYA6QX/DgGAtNnl2CH+LpMqckZ4RHcea45eXNUMZv0iAoE5gR250WmP 3cM8H96Y/4J8VHHVqenjrzwuMnhFH5ne2XM9CvkMTGBuSAk5OoUdT1HybRg1yInHiTcn UatMJvnqwnTOBXJtP0bFizaBkUUq+zz+SAvNwD5lGiFyjWxf+OlXzAUfYvtiXIatT4A1 G9VqqnoG7yzhnICFEU/r6FTC9oDc8JWhS3Q1NFvlf8GNHkw8onAUJcJt3qOA1GP44Bkz w3TA== X-Gm-Message-State: ALoCoQmdZkKQf3DyV06R3JqVkYBX5hgVuul491eaeJ8BwuJgz7GKlsPcZGLqY7LPabgc0ukfc/Fl X-Received: by 10.236.182.229 with SMTP id o65mr31681215yhm.86.1394641838483; Wed, 12 Mar 2014 09:30:38 -0700 (PDT) Original-Received: by 10.170.156.136 with HTTP; Wed, 12 Mar 2014 09:30:08 -0700 (PDT) In-Reply-To: X-Google-Sender-Auth: DhqjqOguaTLNFc-h6RfAwBWPld8 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 140.186.70.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:86778 Archived-At: --20cf30563ed35f41cc04f46b5bed Content-Type: text/plain; charset=ISO-8859-1 On Wed, Mar 12, 2014 at 6:49 AM, Stefan Monnier wrote: > > Some specifics: > > Thanks Florian, this list is very helpful. Just one comment: > > > - Indeed, it seems the documentation is in the wrong order: from a > user's > > perspective, advice-add is what she usually wants and add-function > > is a special case. > > Actually, add-function is likely to become more common with new hooks > using a `*-function' variable modified via add-function rather than > a `*-functions' modified via add-hook. Somewhat relatedly, would you consider renaming advice-add to add-advice (naturally with an alias for backward compatibility)? It's easier to discover related functionality through tab completion, apropos, etc. when its names share a common structure. For example if I was looking for basename functionality and I knew about file-name-directory, `C-h f file-name- TAB' would lead me to `file-name-nondirectory' straightaway. --20cf30563ed35f41cc04f46b5bed Content-Type: text/html; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable

On Wed, Mar 12, 2014 at 6:4= 9 AM, Stefan Monnier <monnier@iro.umontreal.ca> wrote= :
> Some specifics:

Thanks Florian, this list is very helpful. =A0Just one comment:

> =A0- Indeed, it seems the documentation is in the wrong order: from a = user's
> perspective, advice-add is what she usually wants and add-function
> is a special case.

Actually, add-function is likely to become more common with new hooks=
using a `*-function' variable modified via add-function rather than
a `*-functions' modified via add-hook.

= Somewhat relatedly, would you consider renaming advice-add to
add-advice= (naturally with an alias for backward compatibility)?
It's easier t= o discover related functionality through tab
completion, apropos, etc. when its names share a common structure.
For e= xample if I was looking for basename functionality and I knew
about file= -name-directory, `C-h f file-name- TAB' would lead me to
`file-name-= nondirectory' straightaway.

--20cf30563ed35f41cc04f46b5bed--