]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve doc of symbol-name and cl-symbol-name
authorGerd Möllmann <gerd@gnu.org>
Sat, 12 Aug 2023 13:39:54 +0000 (15:39 +0200)
committerGerd Möllmann <gerd@gnu.org>
Sat, 12 Aug 2023 13:39:54 +0000 (15:39 +0200)
src/data.c

index 72f570417d60da68ec8ff9f7ceb2731e922473ea..71e52e727b7dedcf5c2c5aeaf6c61893c1c12099 100644 (file)
@@ -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);