unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: uzibalqa via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
To: 64693@debbugs.gnu.org
Subject: bug#64693: Documentation for the definition of a Menu Item
Date: Mon, 17 Jul 2023 20:44:04 +0000	[thread overview]
Message-ID: <pVA4x9D4tBmzvFLQMEWVjfDwbsY2x8j0Ug2mw2U1zZn4z-LpYYklLFeL7R2ecNSv3FDlyPH6595usIlnosqjSQudl6D_uFIJQ7UnUANRz1s=@proton.me> (raw)


Have been looking at the documentation for 'DEF' in 'define-key'.

(define-key KEYMAP KEY DEF &optional REMOVE)

DEF, the definition of a Menu Item is described in form as 

   (menu-item item-name binding . item-property-list)

Note that DEF constitutes a single list.  The special
dotted notation indicates that 'item-property-list' is not
a separate list but rather enables any number of property
elements in the form of ':keyword value' within the same
list structure.

But such detail is not properly described.  Pointing out how
the description of 'Cons Cells' and 'Dotted Notation' is sketchy
at best in the 'Elisp Reference Manual', and non-existent  in 
the 'Introduction to Programming in Emacs Lisp',  the aforementioned
description should be added in the documentation of 'define-key'.

Furthermore, a more comprehensive explanation of Cons Cells, Dotted
Notation, and Backquote Construct, should be introduced and backed up 
with real-life syntax such as the one described here.

  









             reply	other threads:[~2023-07-17 20:44 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-07-17 20:44 uzibalqa via Bug reports for GNU Emacs, the Swiss army knife of text editors [this message]
2023-07-18 11:03 ` bug#64693: Documentation for the definition of a Menu Item Eli Zaretskii
2023-07-18 11:35   ` uzibalqa via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-07-18 12:58     ` Eli Zaretskii

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='pVA4x9D4tBmzvFLQMEWVjfDwbsY2x8j0Ug2mw2U1zZn4z-LpYYklLFeL7R2ecNSv3FDlyPH6595usIlnosqjSQudl6D_uFIJQ7UnUANRz1s=@proton.me' \
    --to=bug-gnu-emacs@gnu.org \
    --cc=64693@debbugs.gnu.org \
    --cc=uzibalqa@proton.me \
    /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).