From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Richard Stallman Newsgroups: gmane.emacs.bugs Subject: bug#36478: 26.2; Doc strings with "This function has a compiler macro..." and "This function does not change global state" Date: Wed, 03 Jul 2019 21:34:11 -0400 Message-ID: References: <13f5f7df-9017-45a0-986f-8b1a4ee0e9bd@default> Reply-To: rms@gnu.org Content-Type: text/plain; charset=Utf-8 Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="235086"; mail-complaints-to="usenet@blaine.gmane.org" Cc: 36478@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Thu Jul 04 03:36:46 2019 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1hiqg0-000z0B-T1 for geb-bug-gnu-emacs@m.gmane.org; Thu, 04 Jul 2019 03:36:45 +0200 Original-Received: from localhost ([::1]:42270 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hiqfz-00020E-Uq for geb-bug-gnu-emacs@m.gmane.org; Wed, 03 Jul 2019 21:36:43 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:42580) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hiqeN-0000Ep-Ak for bug-gnu-emacs@gnu.org; Wed, 03 Jul 2019 21:35:04 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hiqeM-0007yR-8l for bug-gnu-emacs@gnu.org; Wed, 03 Jul 2019 21:35:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:41380) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hiqeM-0007yI-5k for bug-gnu-emacs@gnu.org; Wed, 03 Jul 2019 21:35:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1hiqeM-0008L9-3D for bug-gnu-emacs@gnu.org; Wed, 03 Jul 2019 21:35:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Richard Stallman Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 04 Jul 2019 01:35:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 36478 X-GNU-PR-Package: emacs Original-Received: via spool by 36478-submit@debbugs.gnu.org id=B36478.156220406232007 (code B ref 36478); Thu, 04 Jul 2019 01:35:02 +0000 Original-Received: (at 36478) by debbugs.gnu.org; 4 Jul 2019 01:34:22 +0000 Original-Received: from localhost ([127.0.0.1]:50201 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hiqdg-0008K8-3Z for submit@debbugs.gnu.org; Wed, 03 Jul 2019 21:34:22 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:58373) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hiqde-0008Jw-5J for 36478@debbugs.gnu.org; Wed, 03 Jul 2019 21:34:18 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:49591) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hiqdY-0007DN-Pw; Wed, 03 Jul 2019 21:34:12 -0400 Original-Received: from rms by fencepost.gnu.org with local (Exim 4.82) (envelope-from ) id 1hiqdX-00065N-Tz; Wed, 03 Jul 2019 21:34:12 -0400 In-Reply-To: <13f5f7df-9017-45a0-986f-8b1a4ee0e9bd@default> (message from Drew Adams on Tue, 2 Jul 2019 11:05:18 -0700 (PDT)) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 209.51.188.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:162039 Archived-At: [[[ 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. ]]] > zerop is a compiled Lisp function in 'subr.el'. > (zerop NUMBER) > This function has a compiler macro 'zerop--anon-cmacro'. > Return t if NUMBER is zero. > This function does not change global state, including the match data. The "compiler macro" line is useful for people debugging compilation, but for Lisp programmers in general it is only clutter. How about replacing that line with the text "(+ compiler macro)" after "compiled Lisp function"? That way it will still be easy to see when you're debugging compilation, but the amount of clutter for everyone else will be less. -- Dr Richard Stallman President, Free Software Foundation (https://gnu.org, https://fsf.org) Internet Hall-of-Famer (https://internethalloffame.org)