GNU bug report logs - #64692
Better descriptions of Cons Cells and Dotted Notation with real-life syntax

Previous Next

Full log

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: uzibalqa <uzibalqa <at> proton.me>
To: "bug-gnu-emacs <at> gnu.org" <bug-gnu-emacs <at> gnu.org>
Subject: Better descriptions of Cons Cells and Dotted Notation with real-life
 syntax
Date: Mon, 17 Jul 2023 20:17:19 +0000

Have been looking at the documentation of menu-item described as

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

This requires a good understanding of Cons Cells and Dotted Notation.
But I do not see a serious attempt to explain this.  Whereas the Emacs 
Lisp Reference Manual isn't designed as a tutorial with explanations,
the "Introduction to Programming in Emacs Lisp" simply refers to the 
"Emacs Lisp Reference Manual" for understanding Cons Cells and Dotted Notation.

This means that the "Introduction to Programming in Emacs Lisp" would benefit 
from some real-life list syntax. Currently I find it short and far from real-life.

For instance, whilst it cam became natural for users to make menus. it would be 
difficult for them to understand that 

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

describes how "item-property-list" would not produce a list inside a list, but a 
single "(menu-item ..." list.

In general, the construction of menus should be better described as it is currently 
too theoretical in the reference.

Previous Next

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