bug#67823: 29.1; Multisession Variables documentation mistake

bug#67823: 29.1; Multisession Variables documentation mistake

[Adam Porter]

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

Hi,

I noticed that the manual section on Multisession Variables seems to
have a minor mistake in that one of the symbol names in the example code
seems to be wrong.  Please see the attached patch.

Thanks,
Adam

[-- Attachment #2: variables.texi.patch --]
[-- Type: text/x-patch, Size: 1873 bytes --]

diff --git a/doc/lispref/variables.texi b/doc/lispref/variables.texi
index 5de5ac6efa7..b4c6d8ac5c3 100644
--- a/doc/lispref/variables.texi
+++ b/doc/lispref/variables.texi
@@ -2971,7 +2971,7 @@ Multisession Variables
 
 @lisp
 @group
-(define-multisession-variable foo-var 0)
+(define-multisession-variable foo 0)
 (defun my-adder (num)
   (interactive "nAdd number: ")
   (setf (multisession-value foo)
@@ -2981,7 +2981,7 @@ Multisession Variables
 @end lisp
 
 @noindent
-This defines the variable @code{foo-var} and binds it to a special
+This defines the variable @code{foo} and binds it to a special
 multisession object which is initialized with the value @samp{0} (if
 the variable doesn't already exist from a previous session).  The
 @code{my-adder} command queries the user for a number, adds this to
@@ -3004,7 +3004,7 @@ Multisession Variables
 @var{package-symbol} isn't given, this will default to the first
 ``segment'' of the @var{name} symbol's name, which is the part of its
 name up to and excluding the first @samp{-}.  For instance, if
-@var{name} is @code{foo-var} and @var{package-symbol} isn't given,
+@var{name} is @code{foo} and @var{package-symbol} isn't given,
 @var{package-symbol} will default to @code{foo}.
 
 @cindex synchronized multisession variables
@@ -3012,7 +3012,7 @@ Multisession Variables
 Multisession variables can be @dfn{synchronized} if @var{bool} is
 non-@code{nil}.  This means that if there're two concurrent Emacs
 instances running, and the other Emacs changes the multisession
-variable @code{foo-var}, the current Emacs instance will retrieve that
+variable @code{foo}, the current Emacs instance will retrieve that
 modified data when accessing the value.  If @var{synchronized} is
 @code{nil} or missing, this won't happen, and the values in all
 Emacs sessions using the variable will be independent of each other.

bug#67823: 29.1; Multisession Variables documentation mistake

[Stefan Kangas]

tags 67823 + patch
thanks

Adam Porter <adam@alphapapa.net> writes:

> I noticed that the manual section on Multisession Variables seems to
> have a minor mistake in that one of the symbol names in the example code
> seems to be wrong.  Please see the attached patch.

Thanks, LGTM.

Could you send it as the result of `git format-patch -1` to help us
install it with correct attribution (to you)?

bug#67823: 29.1; Multisession Variables documentation mistake

[Adam Porter]

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

On 12/14/23 16:37, Stefan Kangas wrote:
> tags 67823 + patch
> thanks
> 
> Adam Porter <adam@alphapapa.net> writes:
> 
>> I noticed that the manual section on Multisession Variables seems to
>> have a minor mistake in that one of the symbol names in the example code
>> seems to be wrong.  Please see the attached patch.
> 
> Thanks, LGTM.
> 
> Could you send it as the result of `git format-patch -1` to help us
> install it with correct attribution (to you)?

Oops, sorry.  Hadn't done this for a while so I just saved a diff 
straight from a Magit diff buffer.  :)  Please see attached.  Thanks.

[-- Attachment #2: 0001-Docs-Fix-symbol-name-in-Multisession-Variables-examp.patch --]
[-- Type: text/x-patch, Size: 2275 bytes --]

From 73bb534740dc2264fb29665e7d0acb2675ad1c94 Mon Sep 17 00:00:00 2001
From: Adam Porter <adam@alphapapa.net>
Date: Thu, 14 Dec 2023 18:28:53 -0600
Subject: [PATCH] Docs: Fix symbol name in Multisession Variables examples

* doc/lispref/variables.texi (Multisession Variables): Fix symbol
name.
---
 doc/lispref/variables.texi | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/doc/lispref/variables.texi b/doc/lispref/variables.texi
index 5de5ac6efa7..b4c6d8ac5c3 100644
--- a/doc/lispref/variables.texi
+++ b/doc/lispref/variables.texi
@@ -2971,7 +2971,7 @@ Multisession Variables
 
 @lisp
 @group
-(define-multisession-variable foo-var 0)
+(define-multisession-variable foo 0)
 (defun my-adder (num)
   (interactive "nAdd number: ")
   (setf (multisession-value foo)
@@ -2981,7 +2981,7 @@ Multisession Variables
 @end lisp
 
 @noindent
-This defines the variable @code{foo-var} and binds it to a special
+This defines the variable @code{foo} and binds it to a special
 multisession object which is initialized with the value @samp{0} (if
 the variable doesn't already exist from a previous session).  The
 @code{my-adder} command queries the user for a number, adds this to
@@ -3004,7 +3004,7 @@ Multisession Variables
 @var{package-symbol} isn't given, this will default to the first
 ``segment'' of the @var{name} symbol's name, which is the part of its
 name up to and excluding the first @samp{-}.  For instance, if
-@var{name} is @code{foo-var} and @var{package-symbol} isn't given,
+@var{name} is @code{foo} and @var{package-symbol} isn't given,
 @var{package-symbol} will default to @code{foo}.
 
 @cindex synchronized multisession variables
@@ -3012,7 +3012,7 @@ Multisession Variables
 Multisession variables can be @dfn{synchronized} if @var{bool} is
 non-@code{nil}.  This means that if there're two concurrent Emacs
 instances running, and the other Emacs changes the multisession
-variable @code{foo-var}, the current Emacs instance will retrieve that
+variable @code{foo}, the current Emacs instance will retrieve that
 modified data when accessing the value.  If @var{synchronized} is
 @code{nil} or missing, this won't happen, and the values in all
 Emacs sessions using the variable will be independent of each other.
-- 
2.30.2

bug#67823: 29.1; Multisession Variables documentation mistake

[Stefan Kangas]

Version: 29.2

Adam Porter <adam@alphapapa.net> writes:


> Oops, sorry.  Hadn't done this for a while so I just saved a diff
> straight from a Magit diff buffer.  :)

:-)

> Please see attached.  Thanks.

Thanks, installed on emacs-29.

1: 2023-12-15 ed8a8a5ba1607a37f0ed9cc11a77221d66946efb
   Fix symbol name in Multisession Variables examples