From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Mauro Aranda Newsgroups: gmane.emacs.bugs Subject: bug#4110: 23.1.50; Checkdoc should recognize "minor mode" Date: Mon, 08 Mar 2021 09:04:19 -0300 Message-ID: <604612c7.1c69fb81.bb823.da84@mx.google.com> References: <87fxaqmvzg.fsf@cyd.mit.edu> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="21076"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) Cc: Lennart Borgman To: 4110@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Mon Mar 08 13:05:33 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 1lJEdh-0005N5-5k for geb-bug-gnu-emacs@m.gmane-mx.org; Mon, 08 Mar 2021 13:05:33 +0100 Original-Received: from localhost ([::1]:45086 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lJEdg-0000aj-5J for geb-bug-gnu-emacs@m.gmane-mx.org; Mon, 08 Mar 2021 07:05:32 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:60602) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lJEdE-0000aQ-Ip for bug-gnu-emacs@gnu.org; Mon, 08 Mar 2021 07:05:04 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:59000) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lJEdC-0007Cv-OX for bug-gnu-emacs@gnu.org; Mon, 08 Mar 2021 07:05:04 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1lJEdC-0005mS-I6 for bug-gnu-emacs@gnu.org; Mon, 08 Mar 2021 07:05:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Mauro Aranda Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 08 Mar 2021 12:05:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 4110 X-GNU-PR-Package: emacs Original-Received: via spool by 4110-submit@debbugs.gnu.org id=B4110.161520507122180 (code B ref 4110); Mon, 08 Mar 2021 12:05:02 +0000 Original-Received: (at 4110) by debbugs.gnu.org; 8 Mar 2021 12:04:31 +0000 Original-Received: from localhost ([127.0.0.1]:42313 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lJEch-0005lf-7X for submit@debbugs.gnu.org; Mon, 08 Mar 2021 07:04:31 -0500 Original-Received: from mail-qv1-f51.google.com ([209.85.219.51]:36035) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lJEce-0005lT-VS for 4110@debbugs.gnu.org; Mon, 08 Mar 2021 07:04:29 -0500 Original-Received: by mail-qv1-f51.google.com with SMTP id d9so4433945qvo.3 for <4110@debbugs.gnu.org>; Mon, 08 Mar 2021 04:04:28 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=message-id:from:to:cc:subject:references:date:in-reply-to :user-agent:mime-version; bh=EAu+U3JVXT45zVZd6nerm3t2d4ik7jNoDr0jrJEklhQ=; b=CzPl/+t89XjAdK51DzOAmk1LoCXv/Z3HCXG4FXoNqaLp/cEwcSI7kxrJys452vuhia X5UDAuCVQ1dTuwkz9a5sm2qRvfpyrHExSJ2/MoCGwCW3VSl+3ovjTX+ofI5O5rrJ0D9Z iMHsjpj2kOhXdS4/6Luzv9vpyPiVqHyb26kutDx4Ybbh2q6/O3GjQFEdiEBAGhCUPRG9 jlXAz6NiiQkLr8dogr+FS3IeZl4z+hlX4QHIQ1/u3LOfDWNJBCfzaMU4AMX4Njp0Vqs+ ZmIgPZYwcT4OczCvOFgmGFyGwVCAx6GbbMIjSg6uSWWoDFvEFmB22TZvx4aB2p8odWuv mGOQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:message-id:from:to:cc:subject:references:date :in-reply-to:user-agent:mime-version; bh=EAu+U3JVXT45zVZd6nerm3t2d4ik7jNoDr0jrJEklhQ=; b=jCW17QAQWJcV9u9aZIhRdKVM/GOAZHMihqCINgJjHdfrQOAsZAH9wf84+NGlXGm/Tn RrNiDG4SGlvHITPc+9xpOoC9j0r+/80U+roHjqX+H3Gi93Oz7Ptxh5quwjEsBaCFBEhD BKt7IQpghO2GMQWXRFe975C3esBpw8wH5aA1E9rrZEHBfJOVuemR5kIfTencqvkem0Ok PuVPiSnA93KQJytP6uBMh60+pqw++4p5mnc9SBEDiBIwfQA2QVzSDbm1tabroOB6iX6a sXJuDCTv6XOM9e8k/saBIJuulCDBju1SGsHeaGbjz4DouYz8v/b95bGYiW0M5mh6J7DI 3ttQ== X-Gm-Message-State: AOAM532w8JdMNk5trkLjt4Im0hxVRTSQW7PsMC2QJJF3SZca5QX5lTpq bVT6u68HEMfV+5Uw+MBURaE= X-Google-Smtp-Source: ABdhPJwBfm26a17kKBEPC9zD89RNplNqQ9p7FXB3td+3ewVG49KZcHyqxVDg2Zs/f+VA6h0dZ1LYaw== X-Received: by 2002:a05:6214:1144:: with SMTP id b4mr20523650qvt.12.1615205063500; Mon, 08 Mar 2021 04:04:23 -0800 (PST) Original-Received: from tbb-desktop ([201.213.132.172]) by smtp.gmail.com with ESMTPSA id 7sm7632188qkm.64.2021.03.08.04.04.21 (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Mon, 08 Mar 2021 04:04:23 -0800 (PST) X-Google-Original-Message-ID: <87im61ua0s.fsf@maurooaranda@gmail.com> In-Reply-To: (Lennart Borgman's message of "Mon, 14 Sep 2009 00:21:07 +0200") 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:201826 Archived-At: Lennart Borgman writes: > You can write "function `my-mode'" or "variable `my-mode'" in a doc > string to make checkdoc happy. However I would like to write "minor > mode `my-mode'" instead since it is more clear. And I think the > `my-mode' link should go to the function since that is wher the doc > string from define-minor-mode shows up. The change to allow this should be pretty simple: just add "mode" to the list of suggested words. But I do wonder if instead checkdoc should be happy just with the symbol ending with "-mode". IOW, I tend to think that there is no ambiguity in "`my-mode'" in a docstring, even if my-mode is defined as a variable and as a function. Any opinions?