From unknown Sun Jun 15 08:02:50 2025 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-Mailer: MIME-tools 5.509 (Entity 5.509) Content-Type: text/plain; charset=utf-8 From: bug#6151 <6151@debbugs.gnu.org> To: bug#6151 <6151@debbugs.gnu.org> Subject: Status: mystery arguments of define-minor-mode + describe-function Reply-To: bug#6151 <6151@debbugs.gnu.org> Date: Sun, 15 Jun 2025 15:02:50 +0000 retitle 6151 mystery arguments of define-minor-mode + describe-function reassign 6151 emacs submitter 6151 jidanni@jidanni.org severity 6151 minor tag 6151 notabug thanks From debbugs-submit-bounces@debbugs.gnu.org Mon May 10 06:03:19 2010 Received: (at submit) by debbugs.gnu.org; 10 May 2010 10:03:19 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OBPpW-0003A0-U8 for submit@debbugs.gnu.org; Mon, 10 May 2010 06:03:19 -0400 Received: from mail.gnu.org ([199.232.76.166] helo=mx10.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OBPpV-00039v-9n for submit@debbugs.gnu.org; Mon, 10 May 2010 06:03:17 -0400 Received: from lists.gnu.org ([199.232.76.165]:46738) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1OBPpS-0004b9-BU for submit@debbugs.gnu.org; Mon, 10 May 2010 06:03:14 -0400 Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1OBPpR-0004Ms-LL for bug-gnu-emacs@gnu.org; Mon, 10 May 2010 06:03:13 -0400 Received: from [140.186.70.92] (port=56881 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OBPpK-0004GO-KO for bug-gnu-emacs@gnu.org; Mon, 10 May 2010 06:03:12 -0400 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00 autolearn=unavailable version=3.3.1 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1OBPov-0007u7-Es for bug-gnu-emacs@gnu.org; Mon, 10 May 2010 06:02:55 -0400 Received: from caiajhbdcaib.dreamhost.com ([208.97.132.81]:43530 helo=homiemail-a7.g.dreamhost.com) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OBPov-0007u0-AE for bug-gnu-emacs@gnu.org; Mon, 10 May 2010 06:02:41 -0400 Received: from jidanni.org (218-163-2-139.dynamic.hinet.net [218.163.2.139]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) (Authenticated sender: jidanni@jidanni.org) by homiemail-a7.g.dreamhost.com (Postfix) with ESMTPSA id 030B525C064 for ; Mon, 10 May 2010 03:02:39 -0700 (PDT) From: jidanni@jidanni.org To: bug-gnu-emacs@gnu.org Subject: mystery arguments of define-minor-mode + describe-function Date: Mon, 10 May 2010 18:02:37 +0800 Message-ID: <871vdkgjlu.fsf@jidanni.org> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-detected-operating-system: by monty-python.gnu.org: GNU/Linux 2.6, seldom 2.4 (older, 4) X-Spam-Score: -5.3 (-----) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -5.3 (-----) Some describe-function results add a mystery argument ARG, not visible in the corresponding lisp code. Or maybe it is visible, but not to your average reader. E.g., here's what describe-function says longlines-mode is an interactive compiled Lisp function in `longlines.el'. (longlines-mode &optional ARG) Toggle Long Lines mode. In Long Lines mode, long lines are wrapped if they extend beyond And here's where we get placed when clicking on longlines.el above ;;;###autoload (define-minor-mode longlines-mode "Toggle Long Lines mode. In Long Lines mode, long lines are wrapped if they extend beyond From debbugs-submit-bounces@debbugs.gnu.org Mon May 10 06:45:48 2010 Received: (at 6151) by debbugs.gnu.org; 10 May 2010 10:45:48 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OBQUe-0003Uy-AF for submit@debbugs.gnu.org; Mon, 10 May 2010 06:45:48 -0400 Received: from mail-bw0-f214.google.com ([209.85.218.214]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OBQUc-0003Us-64 for 6151@debbugs.gnu.org; Mon, 10 May 2010 06:45:46 -0400 Received: by bwz6 with SMTP id 6so1604861bwz.39 for <6151@debbugs.gnu.org>; Mon, 10 May 2010 03:45:40 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:received:mime-version:received:in-reply-to :references:from:date:message-id:subject:to:cc:content-type; bh=4HICv9VRwp6n8ENt6dhokOyCToIwZhuLEGkST4QHpvs=; b=uLYLaEESXeogywb2vvW6gCkeKPYyA4IsGLLZUCuTT/DnxLcPUhx6airnK8gV0nIEhT GOQSgHMJqWKe3ErJ21aWBsor0c2KHjcdPJSZxsd66u5CsP22/7bu+N6XF8JVkcseVD3A Ein7oVHHgVKKcWE9KhYDlxbCqEF9dNRWLZ6S4= DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=mime-version:in-reply-to:references:from:date:message-id:subject:to :cc:content-type; b=JrlozkG21eu735QUH+2OEFdsuqpPnyfQjB5k/r7gQs5dEJHnTPgsBZG7RlhYwhv3ve YoOSNQpsG8+lYte+lMwilMdSiPiSybRE8TtcJMCKbm+p+Wa7WRzcev/KMLk35I29hYhb 0eqIltvqTpzZPRTCGv9cxyn65NG/5+dxx44o4= Received: by 10.204.42.6 with SMTP id q6mr2269962bke.156.1273488339189; Mon, 10 May 2010 03:45:39 -0700 (PDT) MIME-Version: 1.0 Received: by 10.204.84.81 with HTTP; Mon, 10 May 2010 03:45:19 -0700 (PDT) In-Reply-To: <871vdkgjlu.fsf@jidanni.org> References: <871vdkgjlu.fsf@jidanni.org> From: Juanma Barranquero Date: Mon, 10 May 2010 12:45:19 +0200 Message-ID: Subject: Re: bug#6151: mystery arguments of define-minor-mode + describe-function To: jidanni@jidanni.org Content-Type: text/plain; charset=UTF-8 X-Spam-Score: -2.8 (--) X-Debbugs-Envelope-To: 6151 Cc: 6151@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -2.8 (--) On Mon, May 10, 2010 at 12:02, wrote: > Some describe-function results add a mystery argument ARG, not visible > in the corresponding lisp code. > > Or maybe it is visible, but not to your average reader. Among other things, `define-minor-mode' defines a function, in this case longlines-mode; and that function, like all minor modes, has an arg to turn it on or off. So it's not `describe-function' which adds a "mystery argument", but the docstring for the modes, that sometimes lacks the relevant info. That said, any Emacs user should be by now used to minor modes having such an argument... Juanma From debbugs-submit-bounces@debbugs.gnu.org Mon May 10 06:57:18 2010 Received: (at 6151) by debbugs.gnu.org; 10 May 2010 10:57:18 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OBQfl-0003ay-VC for submit@debbugs.gnu.org; Mon, 10 May 2010 06:57:18 -0400 Received: from caiajhbdccah.dreamhost.com ([208.97.132.207] helo=homiemail-a37.g.dreamhost.com) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OBQfj-0003at-OK for 6151@debbugs.gnu.org; Mon, 10 May 2010 06:57:16 -0400 Received: from jidanni.org (218-163-2-139.dynamic.hinet.net [218.163.2.139]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by homiemail-a37.g.dreamhost.com (Postfix) with ESMTP id D3A414D8B9; Mon, 10 May 2010 03:58:03 -0700 (PDT) From: jidanni@jidanni.org To: lekktu@gmail.com Subject: Re: bug#6151: mystery arguments of define-minor-mode + describe-function References: Date: Mon, 10 May 2010 18:57:06 +0800 Message-ID: <877hncm3ct.fsf@jidanni.org> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Spam-Score: -3.4 (---) X-Debbugs-Envelope-To: 6151 Cc: 6151@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -3.4 (---) >>>>> "JB" == Juanma Barranquero writes: JB> "mystery argument", but the docstring for the modes, that sometimes JB> lacks the relevant info. Perhaps an inventory should be made of these defective docstrings, and then they should be repaired. JB> That said, any Emacs user should be by now used to minor modes having JB> such an argument... I'm the dud-type user sometimes referred to in http://www.useit.com/alertbox/ . From debbugs-submit-bounces@debbugs.gnu.org Mon May 10 07:02:41 2010 Received: (at 6151) by debbugs.gnu.org; 10 May 2010 11:02:41 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OBQkz-0003dm-71 for submit@debbugs.gnu.org; Mon, 10 May 2010 07:02:41 -0400 Received: from mail-bw0-f214.google.com ([209.85.218.214]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OBQkx-0003dh-F2 for 6151@debbugs.gnu.org; Mon, 10 May 2010 07:02:40 -0400 Received: by bwz6 with SMTP id 6so1612916bwz.39 for <6151@debbugs.gnu.org>; Mon, 10 May 2010 04:02:33 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:received:mime-version:received:in-reply-to :references:from:date:message-id:subject:to:cc:content-type; bh=XMFd/RnhNnwH7thIUBmSy+oZ/XaJ2BErxV+eWxhrb6M=; b=bE0RuZLeWSsen52nv/WTat2gf6FNqvL4sfHJ17UD7EOTbEAegZscgE/KIj28IEULxK L/eJa71sUbvaT1a+OarLYy9pnQcZSWYMJ2YfUbGrk2N+K8LDTwNW0RN/OhLc6tT1o1G7 Fnxk1j2Qw70oCBNbvSlDsMBsxar7iSbzNxzHw= DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=mime-version:in-reply-to:references:from:date:message-id:subject:to :cc:content-type; b=BvNZy03vGfzz+F1V0LUrvpdCwrRfRdkZZ1Sdz77z/c+1VPNvwS/uxwmeqE1Wo1F+Us BJajB3Amh0pinCKp7sqCLL544ZHQ88hgjmxP2xcqAsDey/Xzw0cA5sFCAdYP/g7eYc8D 33/dsaOCVxhwD04IHi85SQMjg8aNVs6IomnNk= Received: by 10.204.127.90 with SMTP id f26mr2354408bks.78.1273489353263; Mon, 10 May 2010 04:02:33 -0700 (PDT) MIME-Version: 1.0 Received: by 10.204.84.81 with HTTP; Mon, 10 May 2010 04:02:13 -0700 (PDT) In-Reply-To: <877hncm3ct.fsf@jidanni.org> References: <877hncm3ct.fsf@jidanni.org> From: Juanma Barranquero Date: Mon, 10 May 2010 13:02:13 +0200 Message-ID: Subject: Re: bug#6151: mystery arguments of define-minor-mode + describe-function To: jidanni@jidanni.org Content-Type: text/plain; charset=UTF-8 X-Spam-Score: -2.8 (--) X-Debbugs-Envelope-To: 6151 Cc: 6151@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -2.8 (--) On Mon, May 10, 2010 at 12:57, wrote: > Perhaps an inventory should be made of these defective docstrings, and > then they should be repaired. There's such an inventory: it is called Emacs bugs list :-) > I'm the dud-type user sometimes referred to in http://www.useit.com/alertbox/ . That meaning? Juanma From debbugs-submit-bounces@debbugs.gnu.org Mon May 10 07:39:33 2010 Received: (at 6151) by debbugs.gnu.org; 10 May 2010 11:39:33 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OBRKf-0004Rh-GQ for submit@debbugs.gnu.org; Mon, 10 May 2010 07:39:33 -0400 Received: from fg-out-1718.google.com ([72.14.220.159]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OBRKe-0004Rb-53 for 6151@debbugs.gnu.org; Mon, 10 May 2010 07:39:32 -0400 Received: by fg-out-1718.google.com with SMTP id 22so522198fge.15 for <6151@debbugs.gnu.org>; Mon, 10 May 2010 04:39:26 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:received:mime-version:received:in-reply-to :references:from:date:message-id:subject:to:cc:content-type :content-transfer-encoding; bh=n7L1axrYIDJjiLegBsjGahWfGtgYl1Rgl4Ho7wkrd4c=; b=JwK3tcrFEB1KA3N63gH+QJcakyq7HA1xR0bnDBrPUbxYX2p+TdHwrTlB0KsNJkNgY8 BA6TxfsabU1Xa43Zqm1VP6y2tdVgZsS39j8XxH2riTpBwBLpE/uGrznoqAjbYPpNf1W2 PDieXswjCa71FCLTGqi5nhbQAs7bqHpU8Z2X4= DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=mime-version:in-reply-to:references:from:date:message-id:subject:to :cc:content-type:content-transfer-encoding; b=X0iQD+2gGzLhJDA9djs2S9gvpkikSBWNtylvbdjpc53JpkHcoFWyO0UoUBpziB8/KA 972fQr4D4lTsZpJ/FeXsypGyAkHf66GgvHCqHMWiEcQvK2KXDLNUpmzgnnmCImnQPOLS WouwSazcFKavbbWAAjBySdLahcV+ztCFGt7U4= Received: by 10.239.135.2 with SMTP id b2mr344528hbb.206.1273491566128; Mon, 10 May 2010 04:39:26 -0700 (PDT) MIME-Version: 1.0 Received: by 10.239.164.81 with HTTP; Mon, 10 May 2010 04:39:06 -0700 (PDT) In-Reply-To: References: <871vdkgjlu.fsf@jidanni.org> From: Lennart Borgman Date: Mon, 10 May 2010 13:39:06 +0200 Message-ID: Subject: Re: bug#6151: mystery arguments of define-minor-mode + describe-function To: Juanma Barranquero Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable X-Spam-Score: -3.1 (---) X-Debbugs-Envelope-To: 6151 Cc: 6151@debbugs.gnu.org, jidanni@jidanni.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -3.1 (---) On Mon, May 10, 2010 at 12:45 PM, Juanma Barranquero wro= te: > On Mon, May 10, 2010 at 12:02, =C2=A0 wrote: > >> Some describe-function results add a mystery argument ARG, not visible >> in the corresponding lisp code. >> >> Or maybe it is visible, but not to your average reader. > > Among other things, `define-minor-mode' defines a function, in this > case longlines-mode; and that function, like all minor modes, has an > arg to turn it on or off. So it's not `describe-function' which adds a > "mystery argument", but the docstring for the modes, that sometimes > lacks the relevant info. Maybe the define-minor-mode should always add to the docstring that it is a minor mode and provide links between the minor mod variable and the minor mode function? From debbugs-submit-bounces@debbugs.gnu.org Mon May 10 11:33:11 2010 Received: (at 6151) by debbugs.gnu.org; 10 May 2010 15:33:11 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OBUyl-0006Dw-EY for submit@debbugs.gnu.org; Mon, 10 May 2010 11:33:11 -0400 Received: from ironport2-out.teksavvy.com ([206.248.154.183] helo=ironport2-out.pppoe.ca) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OBUyj-0006Dk-Ed for 6151@debbugs.gnu.org; Mon, 10 May 2010 11:33:10 -0400 X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: AvsEAEbE50tLd+Zs/2dsb2JhbACeH3K9OYUUBIwy X-IronPort-AV: E=Sophos;i="4.52,362,1270440000"; d="scan'208";a="63824356" Received: from 75-119-230-108.dsl.teksavvy.com (HELO pastel.home) ([75.119.230.108]) by ironport2-out.pppoe.ca with ESMTP; 10 May 2010 11:33:04 -0400 Received: by pastel.home (Postfix, from userid 20848) id 237B48205; Mon, 10 May 2010 11:33:04 -0400 (EDT) From: Stefan Monnier To: Lennart Borgman Subject: Re: bug#6151: mystery arguments of define-minor-mode + describe-function Message-ID: References: <871vdkgjlu.fsf@jidanni.org> Date: Mon, 10 May 2010 11:33:04 -0400 In-Reply-To: (Lennart Borgman's message of "Mon, 10 May 2010 13:39:06 +0200") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.0.50 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Spam-Score: -2.0 (--) X-Debbugs-Envelope-To: 6151 Cc: Juanma Barranquero , 6151@debbugs.gnu.org, jidanni@jidanni.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -2.0 (--) > Maybe the define-minor-mode should always add to the docstring that it > is a minor mode and provide links between the minor mod variable and > the minor mode function? Yes, it could check the presence of "ARG" in the provided docstring or something like that and add a standard blurb if the docstring doesn't already have it. Stefan From debbugs-submit-bounces@debbugs.gnu.org Wed Jul 13 17:31:19 2011 Received: (at control) by debbugs.gnu.org; 13 Jul 2011 21:31:19 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Qh71a-0000FC-Lr for submit@debbugs.gnu.org; Wed, 13 Jul 2011 17:31:19 -0400 Received: from hermes.netfonds.no ([80.91.224.195]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Qh71Z-0000F1-8b for control@debbugs.gnu.org; Wed, 13 Jul 2011 17:31:17 -0400 Received: from cm-84.215.51.58.getinternet.no ([84.215.51.58] helo=quimbies.gnus.org) by hermes.netfonds.no with esmtpsa (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.72) (envelope-from ) id 1Qh71N-0005Qu-NJ for control@debbugs.gnu.org; Wed, 13 Jul 2011 23:31:05 +0200 Date: Wed, 13 Jul 2011 23:31:05 +0200 Message-Id: To: control@debbugs.gnu.org From: Lars Magne Ingebrigtsen Subject: control message for bug #6151 X-MailScanner-ID: 1Qh71N-0005Qu-NJ X-Netfonds-MailScanner: Found to be clean X-Netfonds-MailScanner-From: larsi@gnus.org MailScanner-NULL-Check: 1311197466.56533@LSU8RGX9ZZ2jMmRur53W6g X-Spam-Status: No X-Spam-Score: -2.7 (--) X-Debbugs-Envelope-To: control X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -2.7 (--) tags 6151 notabug close 6151 From debbugs-submit-bounces@debbugs.gnu.org Wed Jul 13 18:00:18 2011 Received: (at 6151) by debbugs.gnu.org; 13 Jul 2011 22:00:18 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Qh7Ta-0001tu-3k for submit@debbugs.gnu.org; Wed, 13 Jul 2011 18:00:18 -0400 Received: from hermes.netfonds.no ([80.91.224.195]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Qh7TP-0001l5-Ii for 6151@debbugs.gnu.org; Wed, 13 Jul 2011 18:00:08 -0400 Received: from cm-84.215.51.58.getinternet.no ([84.215.51.58] helo=quimbies.gnus.org) by hermes.netfonds.no with esmtpsa (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.72) (envelope-from ) id 1Qh7TB-0005q3-2Q; Wed, 13 Jul 2011 23:59:49 +0200 From: Lars Magne Ingebrigtsen To: jidanni@jidanni.org Subject: Re: mystery arguments of define-minor-mode + describe-function In-Reply-To: <871vdkgjlu.fsf@jidanni.org> (jidanni@jidanni.org's message of "Mon, 10 May 2010 18:02:37 +0800") Date: Wed, 13 Jul 2011 23:30:15 +0200 Message-ID: References: <871vdkgjlu.fsf@jidanni.org> User-Agent: Gnus/5.110018 (No Gnus v0.18) Emacs/24.0.50 (gnu/linux) X-Now-Playing: Tom Tom Club's _Tom Tom Club_ X-Hashcash: 1:23:110713:jidanni@jidanni.org::1yqfhNPf6R5gVmzh:000000000000000000000000000000000000000000DdbG X-Hashcash: 1:23:110713:6151@debbugs.gnu.org::OREyOBKY1RqTc0si:00000000000000000000000000000000000000001GWAU MIME-Version: 1.0 Content-Type: text/plain X-MailScanner-ID: 1Qh7TB-0005q3-2Q X-Netfonds-MailScanner: Found to be clean X-Netfonds-MailScanner-From: larsi@gnus.org MailScanner-NULL-Check: 1311199189.50065@H7yE7F+s8fsk2KjkW+Pa9A X-Spam-Status: No X-Spam-Score: -2.7 (--) X-Debbugs-Envelope-To: 6151 Cc: 6151@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -2.7 (--) jidanni@jidanni.org writes: > Some describe-function results add a mystery argument ARG, not visible > in the corresponding lisp code. > > Or maybe it is visible, but not to your average reader. > > E.g., here's what describe-function says > > longlines-mode is an interactive compiled Lisp function in > `longlines.el'. > > (longlines-mode &optional ARG) > > Toggle Long Lines mode. > In Long Lines mode, long lines are wrapped if they extend beyond > > And here's where we get placed when clicking on longlines.el above > > ;;;###autoload > (define-minor-mode longlines-mode > "Toggle Long Lines mode. > In Long Lines mode, long lines are wrapped if they extend beyond I don't see a bug here -- this is how `define-minor-mode' works. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog http://lars.ingebrigtsen.no/ From debbugs-submit-bounces@debbugs.gnu.org Wed Jul 13 18:00:30 2011 Received: (at 6151) by debbugs.gnu.org; 13 Jul 2011 22:00:30 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Qh7Tm-0001xa-Gz for submit@debbugs.gnu.org; Wed, 13 Jul 2011 18:00:30 -0400 Received: from hermes.netfonds.no ([80.91.224.195]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Qh7TQ-0001l9-Vc for 6151@debbugs.gnu.org; Wed, 13 Jul 2011 18:00:10 -0400 Received: from cm-84.215.51.58.getinternet.no ([84.215.51.58] helo=quimbies.gnus.org) by hermes.netfonds.no with esmtpsa (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.72) (envelope-from ) id 1Qh7TC-0005q6-7q; Wed, 13 Jul 2011 23:59:50 +0200 From: Lars Magne Ingebrigtsen To: Stefan Monnier Subject: Re: bug#6151: mystery arguments of define-minor-mode + describe-function In-Reply-To: (Stefan Monnier's message of "Mon, 10 May 2010 11:33:04 -0400") Date: Wed, 13 Jul 2011 23:31:01 +0200 Message-ID: References: <871vdkgjlu.fsf@jidanni.org> User-Agent: Gnus/5.110018 (No Gnus v0.18) Emacs/24.0.50 (gnu/linux) X-Now-Playing: Tom Tom Club's _Tom Tom Club_ X-Hashcash: 1:23:110713:jidanni@jidanni.org::TEp8e0vfLYgY1JLY:0000000000000000000000000000000000000000002PRQ X-Hashcash: 1:23:110713:6151@debbugs.gnu.org::5TRyTeUXyU/dH3ZP:00000000000000000000000000000000000000000CtTt X-Hashcash: 1:23:110713:lennart.borgman@gmail.com::VsfG+sBGh7OW9ZXQ:000000000000000000000000000000000000ORxF X-Hashcash: 1:23:110713:lekktu@gmail.com::6ffLd8JIN6f9UqzT:0l3RD X-Hashcash: 1:23:110713:monnier@iro.umontreal.ca::ugtVDJxEYLRGTc8V:000000000000000000000000000000000000156b0 MIME-Version: 1.0 Content-Type: text/plain X-MailScanner-ID: 1Qh7TC-0005q6-7q X-Netfonds-MailScanner: Found to be clean X-Netfonds-MailScanner-From: larsi@gnus.org MailScanner-NULL-Check: 1311199190.34117@PFGEVz8k38LzFuUad4WM3w X-Spam-Status: No X-Spam-Score: -2.7 (--) X-Debbugs-Envelope-To: 6151 Cc: Juanma Barranquero , 6151@debbugs.gnu.org, Lennart Borgman , jidanni@jidanni.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -2.7 (--) Stefan Monnier writes: >> Maybe the define-minor-mode should always add to the docstring that it >> is a minor mode and provide links between the minor mod variable and >> the minor mode function? > > Yes, it could check the presence of "ARG" in the provided docstring or > something like that and add a standard blurb if the docstring doesn't > already have it. Opening a new "wishlist" bug report for this would be appropriate. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog http://lars.ingebrigtsen.no/ From debbugs-submit-bounces@debbugs.gnu.org Wed Jul 13 20:58:00 2011 Received: (at 6151) by debbugs.gnu.org; 14 Jul 2011 00:58:00 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QhAFY-0004Uf-4I for submit@debbugs.gnu.org; Wed, 13 Jul 2011 20:58:00 -0400 Received: from caiajhbdcagg.dreamhost.com ([208.97.132.66] helo=homiemail-a4.g.dreamhost.com) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QhAFR-0004UM-Gs for 6151@debbugs.gnu.org; Wed, 13 Jul 2011 20:57:54 -0400 Received: from homiemail-a4.g.dreamhost.com (localhost [127.0.0.1]) by homiemail-a4.g.dreamhost.com (Postfix) with ESMTP id 7ACED51C070; Wed, 13 Jul 2011 17:57:43 -0700 (PDT) DomainKey-Signature: a=rsa-sha1; c=nofws; d=jidanni.org; h=from:to:cc:subject :references:date:message-id:mime-version:content-type; q=dns; s= jidanni.org; b=b16Sh/g/Xgy85HK/HtxQhklC0yDNBdtLxakZvlfGzAxFVkXxO 8dN6wve5a9MmJ7YhotkwNl/u9ssGoC5Z+JN9+Bn0jlpEV5xurZZrIQZ3puq8gQUA nq1wpHyWqVV5Wh9vQXnH8xcFRLd9JKN8cjuxjBPPlVBdbX8AwL4VWco4m8= DKIM-Signature: v=1; a=rsa-sha1; c=relaxed; d=jidanni.org; h=from:to:cc :subject:references:date:message-id:mime-version:content-type; s=jidanni.org; bh=PaBOpIeQQLc5uQRXpRarqaiQWLw=; b=aNO+uG0cG4Na5 5qrRH/5DdSBsCyGT3tHKfUNhhVAoeAfSaiALuTHv3ZEeQpeYwLfifjnskJlH0XR0 Lu8qSD5ZQH/sjHGMc8fucIDIej+7/S/NQT6W+ve7Cpyu8WZI47BKB6l4bUPMEuhM y349BUW4+XOopst9x2eSgkL9I+jva4= Received: from jidanni.org (218-163-0-30.dynamic.hinet.net [218.163.0.30]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) (Authenticated sender: jidanni@jidanni.org) by homiemail-a4.g.dreamhost.com (Postfix) with ESMTPSA id 03B9951C069; Wed, 13 Jul 2011 17:57:42 -0700 (PDT) From: jidanni@jidanni.org To: larsi@gnus.org Subject: Re: bug#6151: mystery arguments of define-minor-mode + describe-function References: Date: Thu, 14 Jul 2011 08:57:39 +0800 Message-ID: <87liw1d6gs.fsf@jidanni.org> MIME-Version: 1.0 Content-Type: text/plain X-Spam-Score: -3.5 (---) X-Debbugs-Envelope-To: 6151 Cc: lekktu@gmail.com, 6151@debbugs.gnu.org, lennart.borgman@gmail.com, monnier@iro.umontreal.ca X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -3.5 (---) >>>>> "LMI" == Lars Magne Ingebrigtsen writes: LMI> Stefan Monnier writes: >>> Maybe the define-minor-mode should always add to the docstring that it >>> is a minor mode and provide links between the minor mod variable and >>> the minor mode function? >> >> Yes, it could check the presence of "ARG" in the provided docstring or >> something like that and add a standard blurb if the docstring doesn't >> already have it. LMI> Opening a new "wishlist" bug report for this would be appropriate. Somebody who understands the issue please do. Even though I was the submitter, this is all now beyond my comprehension abilities. From unknown Sun Jun 15 08:02:50 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Thu, 11 Aug 2011 11:24:06 +0000 User-Agent: Fakemail v42.6.9 # This is a fake control message. # # The action: # bug archived. thanks # This fakemail brought to you by your local debbugs # administrator