unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* bug#44141: 26.3; doc of `default-boundp' and "void" variable values
@ 2020-10-22 15:46 Drew Adams
  2020-12-09 13:20 ` Lars Ingebrigtsen
  0 siblings, 1 reply; 2+ messages in thread
From: Drew Adams @ 2020-10-22 15:46 UTC (permalink / raw)
  To: 44141

The doc of `default-boundp' could be improved by saying explicitly what
it means for a symbol's default value to be "void".  This is not done
anywhere, AFAICT - "void" is undefined.  And for Lisp, especially,
there's some risk of confusion with the value `nil'.

1. The Elisp manual is pretty good on `default-boundp', but saying
something about what "void" means would help.

2. The doc string is not so helpful - you really need to read the short
paragraph in the manual to understand it, I think.  Consider beefing up
the doc string with something like what is said in the manual - it's
short and explanatory.

In GNU Emacs 26.3 (build 1, x86_64-w64-mingw32)
 of 2019-08-29
Repository revision: 96dd0196c28bc36779584e47fffcca433c9309cd
Windowing system distributor `Microsoft Corp.', version 10.0.18362
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static -g3''





^ permalink raw reply	[flat|nested] 2+ messages in thread

* bug#44141: 26.3; doc of `default-boundp' and "void" variable values
  2020-10-22 15:46 bug#44141: 26.3; doc of `default-boundp' and "void" variable values Drew Adams
@ 2020-12-09 13:20 ` Lars Ingebrigtsen
  0 siblings, 0 replies; 2+ messages in thread
From: Lars Ingebrigtsen @ 2020-12-09 13:20 UTC (permalink / raw)
  To: Drew Adams; +Cc: 44141

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

> The doc of `default-boundp' could be improved by saying explicitly what
> it means for a symbol's default value to be "void".  This is not done
> anywhere, AFAICT - "void" is undefined.  And for Lisp, especially,
> there's some risk of confusion with the value `nil'.
>
> 1. The Elisp manual is pretty good on `default-boundp', but saying
> something about what "void" means would help.

I think "void" should be clear enough for somebody reading the lispref
manual.

> 2. The doc string is not so helpful - you really need to read the short
> paragraph in the manual to understand it, I think.  Consider beefing up
> the doc string with something like what is said in the manual - it's
> short and explanatory.

Yeah, the doc string is somewhat incomprehensible.  I've now clarified
in Emacs 28.

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





^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2020-12-09 13:20 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-10-22 15:46 bug#44141: 26.3; doc of `default-boundp' and "void" variable values Drew Adams
2020-12-09 13:20 ` Lars Ingebrigtsen

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