emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

scratch/pkg 5f38ded37be: Improve doc of symbol-name and cl-symbol-name


From: Gerd Moellmann
Subject: scratch/pkg 5f38ded37be: Improve doc of symbol-name and cl-symbol-name
Date: Sat, 12 Aug 2023 09:42:59 -0400 (EDT)

branch: scratch/pkg
commit 5f38ded37beedd5be52d90730fa731da7f95c483
Author: Gerd Möllmann <gerd@gnu.org>
Commit: Gerd Möllmann <gerd@gnu.org>

    Improve doc of symbol-name and cl-symbol-name
---
 src/data.c | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/src/data.c b/src/data.c
index 72f570417d6..71e52e727b7 100644
--- a/src/data.c
+++ b/src/data.c
@@ -771,8 +771,9 @@ DEFUN ("symbol-plist", Fsymbol_plist, Ssymbol_plist, 1, 1, 
0,
 }
 
 DEFUN ("symbol-name", Fsymbol_name, Ssymbol_name, 1, 1, 0,
-       doc: /* Return SYMBOL's name, a string.  */)
-  (register Lisp_Object symbol)
+       doc: /* Return SYMBOL's name, a string.
+If SYMBOL is a keyword, prepend a ':' to the name.*/)
+  (Lisp_Object symbol)
 {
   CHECK_SYMBOL (symbol);
   if (SYMBOL_KEYWORD_P (symbol))
@@ -781,8 +782,10 @@ DEFUN ("symbol-name", Fsymbol_name, Ssymbol_name, 1, 1, 0,
 }
 
 DEFUN ("cl-symbol-name", Fcl_symbol_name, Scl_symbol_name, 1, 1, 0,
-       doc: /* Return SYMBOL's name, a string.  */)
-  (register Lisp_Object symbol)
+       doc: /* Return SYMBOL's name, a string.
+Note that, unlike 'symbol-name' this returns the actual
+symbol-name, without a leading ':' if SYMBOL is a keyword.  */)
+  (Lisp_Object symbol)
 {
   CHECK_SYMBOL (symbol);
   return SYMBOL_NAME (symbol);



reply via email to

[Prev in Thread] Current Thread [Next in Thread]