aboutsummaryrefslogtreecommitdiffstats
path: root/src/data.c
diff options
context:
space:
mode:
authorEli Zaretskii2025-03-06 12:52:05 +0200
committerEli Zaretskii2025-03-06 12:52:05 +0200
commit9065423e709de50509f45d08cc6697d9bb95fc93 (patch)
treec2f9bd1b17b5d57976c30b803b168c3eef5a4027 /src/data.c
parent41fd823d95292d9927325af50673f60bd6d5402d (diff)
downloademacs-9065423e709de50509f45d08cc6697d9bb95fc93.tar.gz
emacs-9065423e709de50509f45d08cc6697d9bb95fc93.zip
; Improve documentation of 2 symbol-related functions
* src/data.c (Fremove_pos_from_symbol, Fbare_symbol): Doc fixes. (Bug#75290)
Diffstat (limited to 'src/data.c')
-rw-r--r--src/data.c8
1 files 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. */)
831 831
832DEFUN ("bare-symbol", Fbare_symbol, Sbare_symbol, 1, 1, 0, 832DEFUN ("bare-symbol", Fbare_symbol, Sbare_symbol, 1, 1, 0,
833 doc: /* Extract, if need be, the bare symbol from SYM. 833 doc: /* Extract, if need be, the bare symbol from SYM.
834SYM is either a symbol or a symbol with position. 834SYM must be either a symbol or a symbol with position, otherwise
835Ignore `symbols-with-pos-enabled'. */) 835the function will signal the `wrong-type-argument' error.
836This function ignores `symbols-with-pos-enabled'. */)
836 (register Lisp_Object sym) 837 (register Lisp_Object sym)
837{ 838{
838 if (BARE_SYMBOL_P (sym)) 839 if (BARE_SYMBOL_P (sym))
@@ -855,7 +856,8 @@ DEFUN ("remove-pos-from-symbol", Fremove_pos_from_symbol,
855 Sremove_pos_from_symbol, 1, 1, 0, 856 Sremove_pos_from_symbol, 1, 1, 0,
856 doc: /* If ARG is a symbol with position, return it without the position. 857 doc: /* If ARG is a symbol with position, return it without the position.
857Otherwise, return ARG unchanged. Ignore `symbols-with-pos-enabled'. 858Otherwise, return ARG unchanged. Ignore `symbols-with-pos-enabled'.
858Compare with `bare-symbol'. */) 859Compare with `bare-symbol', which does the same, but signals an error
860if ARG is not a symbol. */)
859 (register Lisp_Object arg) 861 (register Lisp_Object arg)
860{ 862{
861 if (SYMBOL_WITH_POS_P (arg)) 863 if (SYMBOL_WITH_POS_P (arg))