GNU bug report logs - #75290
Fwd: remove-pos-from-symbol and bare-symbol

Please note: This is a static page, with minimal formatting, updated once a day.
Click here to see this page with the latest information and nicer formatting.

Package: emacs; Severity: wishlist; Reported by: Stefan Kangas <stefankangas@HIDDEN>; dated Thu, 2 Jan 2025 17:23:02 UTC; Maintainer for emacs is bug-gnu-emacs@HIDDEN.

Message received at 75290 <at> debbugs.gnu.org:


Received: (at 75290) by debbugs.gnu.org; 2 Mar 2025 04:18:03 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Sat Mar 01 23:18:02 2025
Received: from localhost ([127.0.0.1]:49730 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1toamA-0008JH-GW
	for submit <at> debbugs.gnu.org; Sat, 01 Mar 2025 23:18:02 -0500
Received: from mail-ed1-x532.google.com ([2a00:1450:4864:20::532]:46108)
 by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128)
 (Exim 4.84_2) (envelope-from <stefankangas@HIDDEN>)
 id 1toam8-0008IP-AN
 for 75290 <at> debbugs.gnu.org; Sat, 01 Mar 2025 23:18:01 -0500
Received: by mail-ed1-x532.google.com with SMTP id
 4fb4d7f45d1cf-5e4b410e48bso5145011a12.0
 for <75290 <at> debbugs.gnu.org>; Sat, 01 Mar 2025 20:18:00 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=gmail.com; s=20230601; t=1740889074; x=1741493874; darn=debbugs.gnu.org;
 h=cc:to:subject:message-id:date:mime-version:references:in-reply-to
 :from:from:to:cc:subject:date:message-id:reply-to;
 bh=lwE/vNPhOpVyO2VThTJB86kYZw5cD4uNjalqcUE6Sbg=;
 b=Qb5xA07Ae4+dOvuYGb2jjssEti06YKQi7g24xdIrHM5Z5THL0WkG1u9I2c52oE8N6A
 CbzM19859Dx1duBYroQczqz535hwfVr9sNX6aqiNl9gDonP40QyWyvRfHPrxEzKkeMKP
 tziy1JtopSLwCLdPfJ3ZfCMdnrcyQeeNoIMIMTfaWI1wYfP7itb7uGPY3ONq9rEagwDV
 VQu6ZT0+vxjeCCCi7LBo/R6cX3aCOZk2XFjd9tnRtxgwbMRBIR1S6Gq/GoVr6NJR1Lg7
 wqD4bTq94bD6dietAZoJ+yG5q09NR7nBYMJ5EU1vos7infx0qHF4Is2EFWJwPmKtAg/M
 Enlg==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20230601; t=1740889074; x=1741493874;
 h=cc:to:subject:message-id:date:mime-version:references:in-reply-to
 :from:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to;
 bh=lwE/vNPhOpVyO2VThTJB86kYZw5cD4uNjalqcUE6Sbg=;
 b=P8vGbXvNmV/SxJ/aa4OMkUZWeFJ0tMJ5C/ykV3vCnpdDyTKSNojgq1Gp4dhqyJPwX5
 aZpUWE+QY2IkE4/137TAVknYg2iBEl2GysfMxpYZYtJC3FB4PKTLB7jkP+qt4ktVmJ62
 lWMydGAiLQUKrK83y2diLUhJdMh5txa49q17YwqXcWx/aO/bM+Gm7LNd2Ye1C+sImpJz
 3qjtleyq3Tsziw3j3ASaZGPIep3EHxIJvU2MmbBJS4My8PO+UulMgmf0BWhGaoedDsWD
 nWHpMQodO8CKo5vwAjDgeYyvG1GwvoliQZnXuiVs1ZfmcP2dTmrXq4Kj6aFZmPHYDFCS
 jN+Q==
X-Gm-Message-State: AOJu0YzNEWhxc/4DJKryQMfUromuYM/TyURD0sOeYJD2IaywzidoEd8A
 Pr06xromRkp+MeWZTdU3KRc8aE6vfIYn58VW1zILi9klKY4IIGwZAoD9rq+1/Cj4nojVQbI8RJu
 BPg4esJTARt/NF/BXjQlK/uMFZDLHi4Yaiqk=
X-Gm-Gg: ASbGncsn0nfuQ/hrQfapCwJnVrOUVm2/M64jZpdFJxzgI8KAUVgZ+iPD2vooyV75sxy
 ZUfdajvjn5e0hsc3oTKk/0t3cjYrxxtdijNg6hdk9jWmqEWfJpgFQYo1APOJtva4HNd9QyzhpnF
 TiRz4Nxae8E0tVvQ+la8Mn5ha01w==
X-Google-Smtp-Source: AGHT+IGcPoOj9/JZzHFuhfUgzJ409pqm4Hx/iCCRX/KgRTrGJUQy1a7+JyHjZAbo9mFwezt8X4oa84TxibtqLja9a54=
X-Received: by 2002:a05:6402:d0b:b0:5e4:c532:d693 with SMTP id
 4fb4d7f45d1cf-5e4d6b8535fmr8546359a12.31.1740889073823; Sat, 01 Mar 2025
 20:17:53 -0800 (PST)
Received: from 753933720722 named unknown by gmailapi.google.com with
 HTTPREST; Sat, 1 Mar 2025 20:17:53 -0800
From: Stefan Kangas <stefankangas@HIDDEN>
In-Reply-To: <Z3qug0VaUoY2lHrt@HIDDEN>
References: <E1rjVZT-0007Ko-8Q@HIDDEN>
 <CADwFkmmg4kHTY4nE-Gs8pxp6peAh67fPpzM8KHfo1U4KTt6B3g@HIDDEN>
 <Z3qug0VaUoY2lHrt@HIDDEN>
MIME-Version: 1.0
Date: Sat, 1 Mar 2025 20:17:53 -0800
X-Gm-Features: AQ5f1JpPXcC4PxJkzvOiI2hTOQt9lvwxOQI9RcQiR9hAJOcDNib3JCZ1nP82Bwc
Message-ID: <CADwFkmkNLpHt5hQ9f8SR0UcvGJfOdh=YTvffO=PzUYmMiFVcZg@HIDDEN>
Subject: Re: bug#75290: Fwd: remove-pos-from-symbol and bare-symbol
To: Alan Mackenzie <acm@HIDDEN>
Content-Type: text/plain; charset="UTF-8"
X-Spam-Score: 0.0 (/)
X-Debbugs-Envelope-To: 75290
Cc: 75290 <at> debbugs.gnu.org, rms@HIDDEN
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.0 (-)

Alan Mackenzie <acm@HIDDEN> writes:

> Hello, Stefan.
>
> Thanks for the Cc:.
>
> On Thu, Jan 02, 2025 at 11:22:44 -0600, Stefan Kangas wrote:
>> Severity: wishlist
>
>> I'm forwarding this to the bug tracker so that we don't lose track of
>> it.  Alan, any comments here?
>
> Yes.  I remember vaguely having some difficulty formulating these doc
> strings.  Making them accurate would have made them less readable.  So I
> erred on the side of sketchy rather than unreadable.  I underestimated
> the amount of difficulty this would cause.
>
>> -------------------- Start of forwarded message --------------------
>> From: Richard Stallman <rms@HIDDEN>
>> To: emacs-devel@HIDDEN
>> Subject: remove-pos-from-symbol and bare-symbol
>> Date: Sun, 10 Mar 2024 22:39:23 -0400
>
>> [[[ To any NSA and FBI agents reading my email: please consider    ]]]
>> [[[ whether defending the US Constitution against all enemies,     ]]]
>> [[[ foreign or domestic, requires you to follow Snowden's example. ]]]
>
>> The doc string of remove-pos-from-symbol says to compare it with
>> bare-symbol.  The doc strings are too sketchy to make clear what the
>> difference is.  Someone who knows should make that clear.
>
>> Is the difference what they do to an argument that is not a symbol?
>
> Yes.  bare-symbol signals an error, remove-pos-from-symbol returns a
> non-symbol argument unchanged.
>
>> If so, it would be good to state that explicitly in the doc string
>> of bare-symbol.  "If need be" is not explicit, not concrete.
>
> OK.  The current doc string for bare-symbol is:
>
>     Extract, if need be, the bare symbol from SYM.
>     SYM is either a symbol or a symbol with position.
>     Ignore `symbols-with-pos-enabled'.
>
> How about the following replacement?
>
>     Extract and return the bare symbol from SYM, when it is a symbol
>     with position.  Return SYM unchanged when it is a symbol.  Otherwise
>     signal an error.  Ignore `symbols-with-pos-enable'.
>
>     Compare with `remove-pos-from-symbol'.

Richard, could you please comment on this?

>> I tried looking at the macros they call, which are in lisp.h.  But
>> those don't have doc strings and just call other functions that have
>> no comments to say what they do.
>
>> The macros and inline functions in lisp.h need to be documented there.
>
> I agree, this is bad and needs rectifying.  The time taken to fix this
> would be less than the time wasted by people reading it and having to
> figure out for themselves what each macro/function does.
>
> When I added symbols with position to this part of lisp.h, I just did so
> in the style of the existing code, i.e. undocumented.
>
> I think somebody should fix it now.

Would you be willing to propose such docstrings?




Information forwarded to bug-gnu-emacs@HIDDEN:
bug#75290; Package emacs. Full text available.

Message received at 75290 <at> debbugs.gnu.org:


Received: (at 75290) by debbugs.gnu.org; 5 Jan 2025 16:08:47 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Sun Jan 05 11:08:47 2025
Received: from localhost ([127.0.0.1]:34895 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1tUTBG-00037U-KX
	for submit <at> debbugs.gnu.org; Sun, 05 Jan 2025 11:08:47 -0500
Received: from mail.muc.de ([193.149.48.3]:48121)
 by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.84_2) (envelope-from <acm@HIDDEN>) id 1tUTBE-00037E-9d
 for 75290 <at> debbugs.gnu.org; Sun, 05 Jan 2025 11:08:45 -0500
Received: (qmail 60211 invoked by uid 3782); 5 Jan 2025 17:08:36 +0100
Received: from muc.de (p4fe153b2.dip0.t-ipconnect.de [79.225.83.178]) (using
 STARTTLS) by colin.muc.de (tmda-ofmipd) with ESMTP;
 Sun, 05 Jan 2025 17:08:36 +0100
Received: (qmail 4104 invoked by uid 1000); 5 Jan 2025 16:08:35 -0000
Date: Sun, 5 Jan 2025 16:08:35 +0000
To: Stefan Kangas <stefankangas@HIDDEN>
Subject: Re: bug#75290: Fwd: remove-pos-from-symbol and bare-symbol
Message-ID: <Z3qug0VaUoY2lHrt@HIDDEN>
References: <E1rjVZT-0007Ko-8Q@HIDDEN>
 <CADwFkmmg4kHTY4nE-Gs8pxp6peAh67fPpzM8KHfo1U4KTt6B3g@HIDDEN>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <CADwFkmmg4kHTY4nE-Gs8pxp6peAh67fPpzM8KHfo1U4KTt6B3g@HIDDEN>
X-Submission-Agent: TMDA/1.3.x (Ph3nix)
From: Alan Mackenzie <acm@HIDDEN>
X-Primary-Address: acm@HIDDEN
X-Spam-Score: 0.0 (/)
X-Debbugs-Envelope-To: 75290
Cc: acm@HIDDEN, 75290 <at> debbugs.gnu.org, rms@HIDDEN
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.0 (-)

Hello, Stefan.

Thanks for the Cc:.

On Thu, Jan 02, 2025 at 11:22:44 -0600, Stefan Kangas wrote:
> Severity: wishlist

> I'm forwarding this to the bug tracker so that we don't lose track of
> it.  Alan, any comments here?

Yes.  I remember vaguely having some difficulty formulating these doc
strings.  Making them accurate would have made them less readable.  So I
erred on the side of sketchy rather than unreadable.  I underestimated
the amount of difficulty this would cause.

> -------------------- Start of forwarded message --------------------
> From: Richard Stallman <rms@HIDDEN>
> To: emacs-devel@HIDDEN
> Subject: remove-pos-from-symbol and bare-symbol
> Date: Sun, 10 Mar 2024 22:39:23 -0400

> [[[ To any NSA and FBI agents reading my email: please consider    ]]]
> [[[ whether defending the US Constitution against all enemies,     ]]]
> [[[ foreign or domestic, requires you to follow Snowden's example. ]]]

> The doc string of remove-pos-from-symbol says to compare it with
> bare-symbol.  The doc strings are too sketchy to make clear what the
> difference is.  Someone who knows should make that clear.

> Is the difference what they do to an argument that is not a symbol?

Yes.  bare-symbol signals an error, remove-pos-from-symbol returns a
non-symbol argument unchanged.

> If so, it would be good to state that explicitly in the doc string
> of bare-symbol.  "If need be" is not explicit, not concrete.

OK.  The current doc string for bare-symbol is:

    Extract, if need be, the bare symbol from SYM.
    SYM is either a symbol or a symbol with position.
    Ignore `symbols-with-pos-enabled'.

How about the following replacement?

    Extract and return the bare symbol from SYM, when it is a symbol
    with position.  Return SYM unchanged when it is a symbol.  Otherwise
    signal an error.  Ignore `symbols-with-pos-enable'.

    Compare with `remove-pos-from-symbol'.

> I tried looking at the macros they call, which are in lisp.h.  But
> those don't have doc strings and just call other functions that have
> no comments to say what they do.

> The macros and inline functions in lisp.h need to be documented there.

I agree, this is bad and needs rectifying.  The time taken to fix this
would be less than the time wasted by people reading it and having to
figure out for themselves what each macro/function does.

When I added symbols with position to this part of lisp.h, I just did so
in the style of the existing code, i.e. undocumented.

I think somebody should fix it now.

> -- 
> Dr Richard Stallman (https://stallman.org)
> Chief GNUisance of the GNU Project (https://gnu.org)
> Founder, Free Software Foundation (https://fsf.org)
> Internet Hall-of-Famer (https://internethalloffame.org)



> -------------------- End of forwarded message --------------------

-- 
Alan Mackenzie (Nuremberg, Germany).




Information forwarded to bug-gnu-emacs@HIDDEN:
bug#75290; Package emacs. Full text available.

Message received at submit <at> debbugs.gnu.org:


Received: (at submit) by debbugs.gnu.org; 2 Jan 2025 17:22:57 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Thu Jan 02 12:22:57 2025
Received: from localhost ([127.0.0.1]:46414 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1tTOuO-0004SL-Gk
	for submit <at> debbugs.gnu.org; Thu, 02 Jan 2025 12:22:56 -0500
Received: from lists.gnu.org ([2001:470:142::17]:54726)
 by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.84_2) (envelope-from <stefankangas@HIDDEN>)
 id 1tTOuM-0004S7-CQ
 for submit <at> debbugs.gnu.org; Thu, 02 Jan 2025 12:22:55 -0500
Received: from eggs.gnu.org ([2001:470:142:3::10])
 by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <stefankangas@HIDDEN>)
 id 1tTOuG-0003sJ-RL
 for bug-gnu-emacs@HIDDEN; Thu, 02 Jan 2025 12:22:49 -0500
Received: from mail-ed1-x52d.google.com ([2a00:1450:4864:20::52d])
 by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128)
 (Exim 4.90_1) (envelope-from <stefankangas@HIDDEN>)
 id 1tTOuE-00067p-Ur
 for bug-gnu-emacs@HIDDEN; Thu, 02 Jan 2025 12:22:48 -0500
Received: by mail-ed1-x52d.google.com with SMTP id
 4fb4d7f45d1cf-5d7e3f1fdafso23674523a12.0
 for <bug-gnu-emacs@HIDDEN>; Thu, 02 Jan 2025 09:22:46 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=gmail.com; s=20230601; t=1735838565; x=1736443365; darn=gnu.org;
 h=to:subject:message-id:date:mime-version:references:from:from:to:cc
 :subject:date:message-id:reply-to;
 bh=VC8im9qxHgkrKHrig3OEEXgtwCxAbOs/dCH8shBMqgM=;
 b=KqTngBppoUManKve9dVutmMRjD2ne+ibKeJjX0o9ZKpMnwic4Hr1rzxdGu6IXVqoly
 bAIB0ZpU+FJicYF01hdEBH0IdjlAyCmCs3j20qs0mUUfxGWTjbyIZ+hYBTHK2ayK0/LW
 JqjS25p3UqU9x3wYbt+V++WHSs7mQzYEu7pmkJAO6WWKWusNVIenyM14RMo6hbXtm+Oe
 aQsU0iw1ZUAqLbvHpfAkCS5nS+cAlvTDHLa1ofIn9AICjX2llHMYx/LjL02l8PUE/K57
 db4+Qw4rzYO8G/ZdTavvryGm2J4Di89CiKtU6LTcNhjNL72YEUYqIrUYpq7JxyWPYoBn
 7fZQ==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20230601; t=1735838565; x=1736443365;
 h=to:subject:message-id:date:mime-version:references:from
 :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to;
 bh=VC8im9qxHgkrKHrig3OEEXgtwCxAbOs/dCH8shBMqgM=;
 b=qndjKvLBYiGEmZBO86o8eDCyMvHiq8uF4iFlxnaLh6f7sCCU3+0CN3gaeKTh/T/8TO
 SQ+7/x4beENOejp6Pnx7tpr7eOs0E64JUr4baUpvz3ovTwOJlnLoTloBquaOaSTYOsOr
 /+zJhqZUrUa9vgyhKxHWS2atY8HCMQ2xgQYceGabVt7On5ZYwhNfGzz8iOPJtuodlls3
 flT5a3Kf6neOn729tDEKACxGxtpkbFgI4F2eoqh85TVpHkm4lBaxP28LS9l+a3qE19Qr
 IbZpzj4PLhhMa3l71vAgIo9IooYuMAn9AU8s9yu/IDDCw97y0Rk43kXA0EMElQDxdrJb
 UR4A==
X-Gm-Message-State: AOJu0YwkMP6JD5E5fQXHOOVT/oECyVVFFHKG4O190mWSil0hcqkGRpSS
 VQzZZ2wxRbbel17yAdFtCbOuJ8lSldqrMU6Z14+wj/moh7JnO+k/iICEU14fEV62FnqaVE7Hbzy
 6RuZFOeFDnJiYzMafG9hc5xsx7UiHufXlcpO/xw==
X-Gm-Gg: ASbGncv9Qiu8jIr0PCV0EvV7tefNPSXAy9S/NXX3eQXf6gowGq/+KGkQV6aY2vElWiM
 6LnKBgE1nubp+ZToNns35esUAOYE5Bj8PvL16Qqs=
X-Google-Smtp-Source: AGHT+IHGrM1jjgXqqzgcAfhydXsXu3CG0gsuVbyeGY8XTArOsYcHKusIf3PMTdljZhqAXH3bzKhYov8fGA5ZQRf+j68=
X-Received: by 2002:a05:6402:4492:b0:5cf:d19c:e21c with SMTP id
 4fb4d7f45d1cf-5d81ddec945mr46470107a12.20.1735838565042; Thu, 02 Jan 2025
 09:22:45 -0800 (PST)
Received: from 753933720722 named unknown by gmailapi.google.com with
 HTTPREST; Thu, 2 Jan 2025 11:22:44 -0600
From: Stefan Kangas <stefankangas@HIDDEN>
References: <E1rjVZT-0007Ko-8Q@HIDDEN>
X-Debbugs-CC: rms@HIDDEN, acm@HIDDEN
MIME-Version: 1.0
Date: Thu, 2 Jan 2025 11:22:44 -0600
Message-ID: <CADwFkmmg4kHTY4nE-Gs8pxp6peAh67fPpzM8KHfo1U4KTt6B3g@HIDDEN>
Subject: Fwd: remove-pos-from-symbol and bare-symbol
To: bug-gnu-emacs@HIDDEN
Content-Type: text/plain; charset="UTF-8"
Received-SPF: pass client-ip=2a00:1450:4864:20::52d;
 envelope-from=stefankangas@HIDDEN; helo=mail-ed1-x52d.google.com
X-Spam_score_int: -20
X-Spam_score: -2.1
X-Spam_bar: --
X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1,
 DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001,
 RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001,
 SPF_PASS=-0.001 autolearn=ham autolearn_force=no
X-Spam_action: no action
X-Spam-Score: 1.0 (+)
X-Debbugs-Envelope-To: submit
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -0.0 (/)

Severity: wishlist

I'm forwarding this to the bug tracker so that we don't lose track of
it.  Alan, any comments here?

-------------------- Start of forwarded message --------------------
From: Richard Stallman <rms@HIDDEN>
To: emacs-devel@HIDDEN
Subject: remove-pos-from-symbol and bare-symbol
Date: Sun, 10 Mar 2024 22:39:23 -0400

[[[ To any NSA and FBI agents reading my email: please consider    ]]]
[[[ whether defending the US Constitution against all enemies,     ]]]
[[[ foreign or domestic, requires you to follow Snowden's example. ]]]

The doc string of remove-pos-from-symbol says to compare it with
bare-symbol.  The doc strings are too sketchy to make clear what the
difference is.  Someone who knows should make that clear.

Is the difference what they do to an argument that is not a symbol?
If so, it would be good to state that explicitly in the doc string
of bare-symbol.  "If need be" is not explicit, not concrete.

I tried looking at the macros they call, which are in lisp.h.  But
those don't have doc strings and just call other functions that have
no comments to say what they do.

The macros and inline functions in lisp.h need to be documented there.

-- 
Dr Richard Stallman (https://stallman.org)
Chief GNUisance of the GNU Project (https://gnu.org)
Founder, Free Software Foundation (https://fsf.org)
Internet Hall-of-Famer (https://internethalloffame.org)



-------------------- End of forwarded message --------------------




Acknowledgement sent to Stefan Kangas <stefankangas@HIDDEN>:
New bug report received and forwarded. Copy sent to rms@HIDDEN, acm@HIDDEN, bug-gnu-emacs@HIDDEN. Full text available.
Report forwarded to rms@HIDDEN, acm@HIDDEN, bug-gnu-emacs@HIDDEN:
bug#75290; Package emacs. Full text available.
Please note: This is a static page, with minimal formatting, updated once a day.
Click here to see this page with the latest information and nicer formatting.
Last modified: Sun, 2 Mar 2025 04:30:02 UTC

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997 nCipher Corporation Ltd, 1994-97 Ian Jackson.