bug#24829: 24.5; `easy-mmode-define-navigation': rename `define-...', per convention

bug#24829: 24.5; `easy-mmode-define-navigation': rename `define-...', per convention

[Drew Adams]

Macro `easy-mmode-define-navigation' apparently defines Emacs commands
(functions).  Per the Emacs Lisp coding conventions, its seems that the
macro should be renamed.

From (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.


In GNU Emacs 24.5.1 (i686-pc-mingw32)
 of 2015-04-11 on LEG570
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --prefix=3D/c/usr --host=3Di686-pc-mingw32'

bug#24829: 24.5; `easy-mmode-define-navigation': rename `define-...', per convention

[Lars Ingebrigtsen]

Drew Adams <drew.adams@oracle.com> writes:

> Macro `easy-mmode-define-navigation' apparently defines Emacs commands
> (functions).  Per the Emacs Lisp coding conventions, its seems that the
> macro should be renamed.
>
>>From (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'm not sure how much of an edict that's supposed to be.

easy-mmode has other functions/macros using the same naming convention
(like easy-mmode-define-syntax), but those don't define functions, of
course.

We could change easy-mmode-define-navigation to, say,
`define-easy-mmode-navigation', but I'm not sure that would be a net
win, confusion wise.  Anybody have an opinion here?

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

bug#24829: 24.5; `easy-mmode-define-navigation': rename `define-...', per convention

[Stefan Kangas]

Lars Ingebrigtsen <larsi@gnus.org> writes:

> Drew Adams <drew.adams@oracle.com> writes:
>
>> Macro `easy-mmode-define-navigation' apparently defines Emacs commands
>> (functions).  Per the Emacs Lisp coding conventions, its seems that the
>> macro should be renamed.
>>
>>>>From (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'm not sure how much of an edict that's supposed to be.
>
> easy-mmode has other functions/macros using the same naming convention
> (like easy-mmode-define-syntax), but those don't define functions, of
> course.
>
> We could change easy-mmode-define-navigation to, say,
> `define-easy-mmode-navigation', but I'm not sure that would be a net
> win, confusion wise.  Anybody have an opinion here?

FWIW, I also think the original name is less confusing.  It also
includes the package name prefix, which is probably nice given its
surrounding context.

Best regards,
Stefan Kangas

bug#24829: 24.5; `easy-mmode-define-navigation': rename `define-...', per convention

[Lars Ingebrigtsen]

Stefan Kangas <stefan@marxist.se> writes:

> FWIW, I also think the original name is less confusing.  It also
> includes the package name prefix, which is probably nice given its
> surrounding context.

OK, closing this bug report.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no