bug#40341: [PATCH] * doc/lispref/os.texi (Session Management): make example homoiconic

bug#40341: [PATCH] * doc/lispref/os.texi (Session Management): make example homoiconic

[oitofelix]

[-- Attachment #1: Type: text/plain, Size: 280 bytes --]


I think hardcoded strings with Lisp code in Lisp code is a bad practice,
given that Lisp’s main distinguishing feature is its homocoinicity.  In
my opinion the Lisp reference manual should encouraged homoiconic
programming --- or, at least, not to promote the contrary.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: make example homoiconic --]
[-- Type: text/x-diff, Size: 927 bytes --]

From 5a707993cdee582dcbc423f990205798ae3c421e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bruno=20F=C3=A9lix=20Rezende=20Ribeiro?= <oitofelix@gnu.org>
Date: Tue, 31 Mar 2020 03:55:35 -0300
Subject: [PATCH] * doc/lispref/os.texi (Session Management): make example
 homoiconic

---
 doc/lispref/os.texi | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi
index e72858b..680d327 100644
--- a/doc/lispref/os.texi
+++ b/doc/lispref/os.texi
@@ -2675,10 +2675,10 @@ Emacs is restarted by the session manager.
 
 @group
 (defun save-yourself-test ()
-  (insert "(save-current-buffer
-  (switch-to-buffer \"*scratch*\")
-  (insert \"I am restored\"))")
-  nil)
+    (insert (format "%S" '(save-current-buffer
+                           (switch-to-buffer "*scratch*")
+                           (insert "I am restored"))))
+    nil)
 @end group
 @end example
 
-- 
2.7.4


[-- Attachment #3: Type: text/plain, Size: 97 bytes --]


-- 
Bruno Félix Rezende Ribeiro (oitofelix) [0x28D618AF]
<http://oitofelix.freeshell.org/>

bug#40341: [PATCH] * doc/lispref/os.texi (Session Management): make example homoiconic

[Noam Postavsky]

severity 40341 minor
quit

oitofelix@gnu.org writes:

> --- a/doc/lispref/os.texi
> +++ b/doc/lispref/os.texi
> @@ -2675,10 +2675,10 @@ Emacs is restarted by the session manager.
>  
>  @group
>  (defun save-yourself-test ()
> -  (insert "(save-current-buffer
> -  (switch-to-buffer \"*scratch*\")
> -  (insert \"I am restored\"))")
> -  nil)
> +    (insert (format "%S" '(save-current-buffer
> +                           (switch-to-buffer "*scratch*")
> +                           (insert "I am restored"))))
> +    nil)

Shouldn't this example also be using set-buffer instead of
switch-to-buffer?  (Or rather, with-current-buffer instead of
save-current-buffer + switch-to-buffer.)

bug#40341: [PATCH] * doc/lispref/os.texi (Session Management): make example homoiconic

[Eli Zaretskii]

> From: Noam Postavsky <npostavs@gmail.com>
> Date: Tue, 14 Apr 2020 09:52:56 -0400
> Cc: 40341@debbugs.gnu.org
> 
> > +    (insert (format "%S" '(save-current-buffer
> > +                           (switch-to-buffer "*scratch*")
> > +                           (insert "I am restored"))))
> > +    nil)
> 
> Shouldn't this example also be using set-buffer instead of
> switch-to-buffer?  (Or rather, with-current-buffer instead of
> save-current-buffer + switch-to-buffer.)

It wouldn't hurt to put our money where our mouth is, I agree.

bug#40341: [PATCH] * doc/lispref/os.texi (Session Management): make example homoiconic

[Lars Ingebrigtsen]

oitofelix@gnu.org writes:

> I think hardcoded strings with Lisp code in Lisp code is a bad practice,
> given that Lisp’s main distinguishing feature is its homocoinicity.  In
> my opinion the Lisp reference manual should encouraged homoiconic
> programming --- or, at least, not to promote the contrary.

[...]

>  @group
>  (defun save-yourself-test ()
> -  (insert "(save-current-buffer
> -  (switch-to-buffer \"*scratch*\")
> -  (insert \"I am restored\"))")
> -  nil)
> +    (insert (format "%S" '(save-current-buffer
> +                           (switch-to-buffer "*scratch*")
> +                           (insert "I am restored"))))
> +    nil)

Thanks; applied to Emacs 28.1.

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

bug#40341: [PATCH] * doc/lispref/os.texi (Session Management): make example homoiconic

[Lars Ingebrigtsen]

Noam Postavsky <npostavs@gmail.com> writes:

> Shouldn't this example also be using set-buffer instead of
> switch-to-buffer?  (Or rather, with-current-buffer instead of
> save-current-buffer + switch-to-buffer.)

I've now done this change.

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