From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: master 69d1278527: ; Fix some doc strings in elisp-mode.el Date: Thu, 17 Nov 2022 08:53:17 +0200 Message-ID: <83sfiidqci.fsf@gnu.org> References: <166853515177.10254.3755761779228774904@vcs2.savannah.gnu.org> <20221115175912.8BC26C00613@vcs2.savannah.gnu.org> <87sfiijohr.fsf@web.de> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="15913"; mail-complaints-to="usenet@ciao.gmane.io" Cc: emacs-devel@gnu.org To: Michael Heerdegen Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Thu Nov 17 07:54:24 2022 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1ovYn0-0003qJ-AS for ged-emacs-devel@m.gmane-mx.org; Thu, 17 Nov 2022 07:54:22 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ovYmO-0008Mm-FL; Thu, 17 Nov 2022 01:53:45 -0500 Original-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 ) id 1ovYmG-0008J9-LF for emacs-devel@gnu.org; Thu, 17 Nov 2022 01:53:36 -0500 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ovYmG-0007BC-AD; Thu, 17 Nov 2022 01:53:36 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=+DIxvef8j/35UNLI37Jbq2BBVA5ytSwYi7K7awLQFy4=; b=OLrWjeSQ2rOb b/gLXWz7kIPe1U1K3fEaFZJrBx2VBRvUXppThyLqUGNBGPkyHAHD3E98c9jqGcMAkyXocfWy3Drjs iIMMSbd/mqellsk3AANHnZ8NwgQUsy3eyaT//LcaJbpD9tmhvCxyLBcLu+BFTeww0OTTwRy3DaYWQ mU2QxY1FJ3lZUvD/SiFWaloQi4pMRX0ucfGDPTJqAPZphW/cWBDTEuJ622105jtWX2T6hTxJ08Yvy XsgL6BB2IbeHABx95Pataav1tZ9eu5Ebwt+JrzufqL6sipJm+GIcuWR8zUGxQPc0r4Fbu5SDkrPPw EotmJjmu2/fhUmqnR6HEYw==; Original-Received: from [87.69.77.57] (helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ovYly-0007yN-5o; Thu, 17 Nov 2022 01:53:36 -0500 In-Reply-To: <87sfiijohr.fsf@web.de> (message from Michael Heerdegen on Thu, 17 Nov 2022 03:36:48 +0100) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:300011 Archived-At: > From: Michael Heerdegen > Cc: Eli Zaretskii > Date: Thu, 17 Nov 2022 03:36:48 +0100 > > Eli Zaretskii writes: > > > branch: master > > commit 69d1278527f0a883d55b91088c8e1b04d9e07e81 > > Author: Eli Zaretskii > > Commit: Eli Zaretskii > > > (defun eval-defun (edebug-it) > > - "Evaluate the top-level form containing point. > > + "Evaluate EDEBUG-IT or the top-level form containing point. > > Unless I don't parse this new first sentence wrong (sorry then): > > This is incorrect. EDEBUG-IT is not an expression. It's the > prefix argument and causes the top-level form to be instrumented for > Edebug, instead of evaluating it normally. Right? Truth be told, I don't know. The original doc string was obviously incomplete, so I completed it as best I understood the code during the 5 sec I could dedicate to this task. Part of the reason for writing the text I installed was to prompt "Someone" to help me get our act together in this case. Feel free to describe in more detail what the code does with this argument (ideally, with pointers to the code), and then we can discuss how to improve the doc string. Thanks.