From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#21709: 25.0.50; doc of :variable in `define-minor-mode' Date: Mon, 16 Aug 2021 14:22:58 +0200 Message-ID: <87y291d1el.fsf@gnus.org> References: <131df705-9c27-4cb5-940e-755ea2635031@default> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="32309"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) Cc: 21709@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Mon Aug 16 14:24:11 2021 Return-path: Envelope-to: geb-bug-gnu-emacs@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 1mFbf0-00089v-Uh for geb-bug-gnu-emacs@m.gmane-mx.org; Mon, 16 Aug 2021 14:24:10 +0200 Original-Received: from localhost ([::1]:56744 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mFbez-0004A7-57 for geb-bug-gnu-emacs@m.gmane-mx.org; Mon, 16 Aug 2021 08:24:09 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:34210) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mFbes-00049X-Ny for bug-gnu-emacs@gnu.org; Mon, 16 Aug 2021 08:24:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:37276) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mFbes-0005Om-H3 for bug-gnu-emacs@gnu.org; Mon, 16 Aug 2021 08:24:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mFbes-0005Zm-Ch for bug-gnu-emacs@gnu.org; Mon, 16 Aug 2021 08:24:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 16 Aug 2021 12:24:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 21709 X-GNU-PR-Package: emacs Original-Received: via spool by 21709-submit@debbugs.gnu.org id=B21709.162911659121359 (code B ref 21709); Mon, 16 Aug 2021 12:24:02 +0000 Original-Received: (at 21709) by debbugs.gnu.org; 16 Aug 2021 12:23:11 +0000 Original-Received: from localhost ([127.0.0.1]:48822 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mFbe3-0005YR-76 for submit@debbugs.gnu.org; Mon, 16 Aug 2021 08:23:11 -0400 Original-Received: from quimby.gnus.org ([95.216.78.240]:43136) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mFbe1-0005YC-Iv for 21709@debbugs.gnu.org; Mon, 16 Aug 2021 08:23:10 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnus.org; s=20200322; h=Content-Type:MIME-Version:Message-ID:In-Reply-To:Date: References:Subject:Cc:To:From:Sender:Reply-To:Content-Transfer-Encoding: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=PHNOdXBVG07Ew+wiHpEXGw28DjIhqSz2pG/IM7pmKJg=; b=no3Czu7tkDPFFHvjic1uQOzb3R pQToLJjnvIfJfbY7RkSDYFF1Py1iljkD2MqOsD2fzSUIMLt5JRM9NwmcibUUvIMQ2aIk7XK/lpIxP wt1WjpgoTbSzCLYG4yDHmpsG3y3DqL55pLtD4aONj4o/hOjMSuLGBXvbzCHm47G55RUQ=; Original-Received: from [84.212.220.105] (helo=elva) by quimby.gnus.org with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1mFbdq-0004fq-Iz; Mon, 16 Aug 2021 14:23:02 +0200 In-Reply-To: <131df705-9c27-4cb5-940e-755ea2635031@default> (Drew Adams's message of "Mon, 19 Oct 2015 08:14:57 -0700 (PDT)") X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list 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-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:212001 Archived-At: Drew Adams writes: > The doc is unclear - both the doc string and (elisp) `Defining Minor > Modes'. Specifically, the part about PLACE being (GET . SET). > > PLACE can also be of the form (GET . SET), where GET is > an expression that returns the current state, and SET is > a function that takes one argument, the new state, and > sets it. > > PLACE can also be a cons '(GET . SET)', where GET is an expression that > returns the current state, and SET is a function of one argument (a > state) that sets it. > > Surely the function does not "set" a "state". It might set the > variable to a new value (but it does not "set" the value). > > What is the function argument? A "state"? What does that mean? > State of what? What form does this "state" take? What does it do? > > My guess is that the doc should says something like this: > > The argument is the new variable value, which is assigned to PLACE. > > Presumably, "state" should be replaced by "value" everywhere, here. > But that's just a guess. I think "state" is fine in this context, but you're right that this can be improved. I've altered both the doc string and the manual so be more along your suggested "which is assigned to PLACE". -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no