From 9065423e709de50509f45d08cc6697d9bb95fc93 Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Thu, 6 Mar 2025 12:52:05 +0200 Subject: [PATCH] ; Improve documentation of 2 symbol-related functions * src/data.c (Fremove_pos_from_symbol, Fbare_symbol): Doc fixes. (Bug#75290) --- src/data.c | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/data.c b/src/data.c index 247b0da1bae..aa203768e59 100644 --- a/src/data.c +++ b/src/data.c @@ -831,8 +831,9 @@ Doing that might make Emacs dysfunctional, and might even crash Emacs. */) DEFUN ("bare-symbol", Fbare_symbol, Sbare_symbol, 1, 1, 0, doc: /* Extract, if need be, the bare symbol from SYM. -SYM is either a symbol or a symbol with position. -Ignore `symbols-with-pos-enabled'. */) +SYM must be either a symbol or a symbol with position, otherwise +the function will signal the `wrong-type-argument' error. +This function ignores `symbols-with-pos-enabled'. */) (register Lisp_Object sym) { if (BARE_SYMBOL_P (sym)) @@ -855,7 +856,8 @@ DEFUN ("remove-pos-from-symbol", Fremove_pos_from_symbol, Sremove_pos_from_symbol, 1, 1, 0, doc: /* If ARG is a symbol with position, return it without the position. Otherwise, return ARG unchanged. Ignore `symbols-with-pos-enabled'. -Compare with `bare-symbol'. */) +Compare with `bare-symbol', which does the same, but signals an error +if ARG is not a symbol. */) (register Lisp_Object arg) { if (SYMBOL_WITH_POS_P (arg))