unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
* (elisp) Function Safety
@ 2019-04-14 18:54 Basil L. Contovounesios
  2019-04-14 19:16 ` Eli Zaretskii
  0 siblings, 1 reply; 2+ messages in thread
From: Basil L. Contovounesios @ 2019-04-14 18:54 UTC (permalink / raw)
  To: emacs-devel; +Cc: Richard Stallman

While looking into clarifying the documentation of the side-effect-free
property[1], I noticed the safe-function property listed along with its
associated node in the manual, (info "(elisp) Function Safety").

This node makes no mention of the safe-function property or the related
user option safe-functions, both of which are documented in the
commentary of lisp/emacs-lisp/unsafep.el.  That is, until one looks at
the Texinfo source, where this documentation was commented out quite a
while ago[2].

So, my question is why was this documentation commented out?  Is it
still relevant and welcome (probably following some copyedits), or
should it be deleted altogether?

[1]: https://lists.gnu.org/archive/html/emacs-devel/2019-04/msg00332.html

[2: a68defffda]: (Defining Functions): Explain about redefining primitives. ...
  2003-06-30 10:40:27 +0000
  https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=a68defffdafbe7e61b8db90d534c04e147b14f91

Thanks,

-- 
Basil



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

* Re: (elisp) Function Safety
  2019-04-14 18:54 (elisp) Function Safety Basil L. Contovounesios
@ 2019-04-14 19:16 ` Eli Zaretskii
  0 siblings, 0 replies; 2+ messages in thread
From: Eli Zaretskii @ 2019-04-14 19:16 UTC (permalink / raw)
  To: Basil L. Contovounesios; +Cc: rms, emacs-devel

> From: "Basil L. Contovounesios" <contovob@tcd.ie>
> Date: Sun, 14 Apr 2019 19:54:01 +0100
> Cc: Richard Stallman <rms@gnu.org>
> 
> So, my question is why was this documentation commented out?

I guess it was deemed too detailed/obscure.  The ELisp manual is a
large book, so stuff that doesn't have to be in it was removed.  Maybe
Richard remembers why he did it back then.

We could convert @ignore into @ifinfo, if we think this information is
useful.



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

end of thread, other threads:[~2019-04-14 19:16 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-04-14 18:54 (elisp) Function Safety Basil L. Contovounesios
2019-04-14 19:16 ` Eli Zaretskii

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