unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: uzibalqa <uzibalqa@proton.me>
Cc: 64693-done@debbugs.gnu.org
Subject: bug#64693: Documentation for the definition of a Menu Item
Date: Tue, 18 Jul 2023 14:03:32 +0300	[thread overview]
Message-ID: <83o7k97a7v.fsf@gnu.org> (raw)
In-Reply-To: <pVA4x9D4tBmzvFLQMEWVjfDwbsY2x8j0Ug2mw2U1zZn4z-LpYYklLFeL7R2ecNSv3FDlyPH6595usIlnosqjSQudl6D_uFIJQ7UnUANRz1s=@proton.me> (bug-gnu-emacs@gnu.org)

> Date: Mon, 17 Jul 2023 20:44:04 +0000
> From:  uzibalqa via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
> 
> 
> 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.

If you type "i property list RET" in Info, you will land in the
"Property Lists" node, which starts by saying:

  A “property list” (“plist” for short) is a list of paired elements.
  Each of the pairs associates a property name (usually a symbol) with a
  property or value.

So I think when the manual says that item-property-list is a property
list, it does a good job.

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

This is all properly done elsewhere in the manual; see my response to
your report in bug#64692.

So I'm closing this bug.





  reply	other threads:[~2023-07-18 11:03 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-07-17 20:44 bug#64693: Documentation for the definition of a Menu Item uzibalqa via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-07-18 11:03 ` Eli Zaretskii [this message]
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=83o7k97a7v.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=64693-done@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).