GNU bug report logs - #13740
About a coding convention

Previous Next

Full log

View this message in rfc822 format

From: Xue Fuqiao <xfq.free <at> gmail.com>
To: Glenn Morris <rgm <at> gnu.org>
Cc: 13740 <at> debbugs.gnu.org
Subject: bug#13740: About a coding convention
Date: Thu, 21 Feb 2013 08:28:57 +0800

On Tue, 19 Feb 2013 14:55:35 -0500
Glenn Morris <rgm <at> gnu.org> wrote:

> Xue Fuqiao wrote:
> > In (info "(elisp) Coding Conventions"):
> >
> >    * Constructs that define a function or variable should be macros,
> >      not functions, and their names should start with `define-'.  The
> >      macro should receive the name to be defined as the first argument.
> >      That will help various tools find the definition automatically.
> >      Avoid constructing the names in the macro itself, since that would
> >      confuse these tools.
> >
> > I think macros like `cl-defsubst', `cl-defun' should be mentioned here.

> Why?

They are macros that define functions, but they don't start with `define-'.

>  What would you say about them?

Maybe something like this:

Constructs that define a function or variable should be macros, not functions, and their names should start with `define-', except for some macros in `cl-lib', like `cl-defsubst' and `cl-defun'.

-- 
Best regards, Xue Fuqiao.
http://www.emacswiki.org/emacs/XueFuqiao

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.