From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Jim Porter Newsgroups: gmane.emacs.bugs Subject: bug#62677: 30.0.50; Need to find a better name for flyspell-prog-mode Date: Thu, 6 Apr 2023 10:46:13 -0700 Message-ID: <7dd7ff53-64e5-80fe-f375-fbdbda5b055f@gmail.com> References: <87mt3mv5e9.fsf@web.de> <076460cb-f203-de49-c949-bdc213fd1965@gmail.com> <83y1n5r0i9.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 8bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="20207"; mail-complaints-to="usenet@ciao.gmane.io" Cc: michael_heerdegen@web.de, 62677@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Thu Apr 06 19:47:17 2023 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 1pkThd-0004yI-Bk for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 06 Apr 2023 19:47:17 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pkThQ-0006Ga-JZ; Thu, 06 Apr 2023 13:47:04 -0400 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 1pkThO-0006Fz-MY for bug-gnu-emacs@gnu.org; Thu, 06 Apr 2023 13:47:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pkThO-0005NU-EQ for bug-gnu-emacs@gnu.org; Thu, 06 Apr 2023 13:47:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pkThN-0004Af-TM for bug-gnu-emacs@gnu.org; Thu, 06 Apr 2023 13:47:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Jim Porter Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 06 Apr 2023 17:47:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 62677 X-GNU-PR-Package: emacs Original-Received: via spool by 62677-submit@debbugs.gnu.org id=B62677.168080318415965 (code B ref 62677); Thu, 06 Apr 2023 17:47:01 +0000 Original-Received: (at 62677) by debbugs.gnu.org; 6 Apr 2023 17:46:24 +0000 Original-Received: from localhost ([127.0.0.1]:55094 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pkTgl-00049R-Na for submit@debbugs.gnu.org; Thu, 06 Apr 2023 13:46:24 -0400 Original-Received: from mail-pj1-f47.google.com ([209.85.216.47]:56106) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pkTgh-000493-35 for 62677@debbugs.gnu.org; Thu, 06 Apr 2023 13:46:22 -0400 Original-Received: by mail-pj1-f47.google.com with SMTP id l7so37931438pjg.5 for <62677@debbugs.gnu.org>; Thu, 06 Apr 2023 10:46:19 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; t=1680803173; x=1683395173; h=content-transfer-encoding:in-reply-to:from:references:cc:to :content-language:subject:mime-version:date:message-id:from:to:cc :subject:date:message-id:reply-to; bh=/3DUcoEO0dll2LqloltmiDkNhQQZKksHuymSsZsrW2k=; b=XnTapxtj0FklZN9gB5HwAX717eYldDSlFxHc/Ji+/K4qUhj/Dg7F78WhW9R9szw64T To21PcpuQbbsdlRaovwiFaXFRyQoLXiTA34H/t0QT/WhM2McBt2g2wL26gvedxEYHCFc X+PNqqkQ/WT4opDYJVQSKaOohfUXQyQzTpzYTTD2X/GnLqlvyukFPz3JHxiPf1yMY9+f TRK/lpuv3d8JbEypkaA7CNmSEiX0FuhmRbFdpNCSQxXqk9bCGJ1hesP9ZzYDwlEwWM1M Po+gX6gXnMr/L0GNA2rbZZTqa6h4/6mZGJWqsTQ6QQQqt3mOxfvlkaDwO/2KGkhzc21F +7UA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; t=1680803173; x=1683395173; h=content-transfer-encoding:in-reply-to:from:references:cc:to :content-language:subject:mime-version:date:message-id :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=/3DUcoEO0dll2LqloltmiDkNhQQZKksHuymSsZsrW2k=; b=vyZj/u4wsZVfe0ymJWLyAldvM5L/c+Q3fPEOSoAA2IjhA0Lu8+/zA20TTXuptOymyB iER/z2JGe4DCbM0Lkdc6stRuESTfM8wxqt9LMpCAWyOjtlrS6JyWMXbuwzVo02+iunmU ezkBZYeFNCjZc2IYWwK9/ZIQR0hG2EKWmQWoWpsWgysrkOvicbM7IlZigoK4ZDfcct7q FcuyEvL9FEin4jy6f/3OZIM+JqlqtbRKpJ1szPlIvb2l4mGXpcO9HuODDxUSazayeav5 9nwvIVeuhlVyHMSTXxVsSe692LRruxt+4xzdbnPU9tXEHcctbdEAwET+wWU3evpfMkOT nT1g== X-Gm-Message-State: AAQBX9epMd4pI8U8MnrbWXnVwET0OH8EgC0XoUwLojKa9j3u13z/u9uv /DNZ5xowWJnA4CRn9berWBk= X-Google-Smtp-Source: AKy350a+J9Das6l3bo+IPoBEHhcJuYgSuscKcYxLwxxnmMtVXaQ4LTVZkIQIQfM+QKivj23DRRo/1g== X-Received: by 2002:a17:902:c412:b0:1a2:8c7e:f312 with SMTP id k18-20020a170902c41200b001a28c7ef312mr13605768plk.39.1680803172789; Thu, 06 Apr 2023 10:46:12 -0700 (PDT) Original-Received: from [192.168.1.2] (cpe-76-168-148-233.socal.res.rr.com. [76.168.148.233]) by smtp.googlemail.com with ESMTPSA id a18-20020a1709027d9200b001a5059861adsm1020013plm.224.2023.04.06.10.46.11 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Thu, 06 Apr 2023 10:46:12 -0700 (PDT) Content-Language: en-US In-Reply-To: <83y1n5r0i9.fsf@gnu.org> 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-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:259339 Archived-At: On 4/5/2023 11:24 PM, Eli Zaretskii wrote: >> Date: Wed, 5 Apr 2023 13:29:59 -0700 >> From: Jim Porter >> >> On 4/5/2023 6:13 AM, Michael Heerdegen wrote: >>> `flyspell-prog-mode' is a variant of `flyspell-mode' for editing >>> programs: it limits spell checking to areas of text fontified with >>> certain faces (`flyspell-prog-text-faces', normally strings and >>> comments). The intention is obviously to skip keywords and tags that >>> are used by the programming language itself. >> >> For what it's worth, when I started using flyspell-mode last year and >> subsequently discovered flyspell-prog-mode, I immediately understood >> what its intent was from the name. So from my perspective, it's actually >> a very good name. > > That depends on what you understood ;-) It could be that you > understood it immediately, but incorrectly or inaccurately. To be clear, my understanding was that 'flyspell-prog-mode' is what you should use for modes where some text should be ignored for spell-checking. (Code is the most obvious example, but not the only one.) >>> This mode is geared toward text modes. In buffers that contain >>> code, ‘flyspell-prog-mode’ is usually a better choice. > > The above is inaccurate as well: text-derived modes for markup text > can also benefit. Basically, anything where you have keywords that > are not necessarily words in a human language. Maybe something like this would be more-precise? "This mode spell checks all the text in a buffer. In buffers that contain text that shouldn't be spell-checked (such as code or markup), 'flyspell-prog-mode' is usually a better choice." Then, we could expand on the docstring for 'flyspell-prog-mode', since it's pretty short right now. > IMO, we should start with what the manual says: > > Flyspell Prog mode works just like ordinary Flyspell mode, except > that it only checks words in comments and string constants. This > feature is useful for editing programs. > > Which might try to explain the name, but in doing so, it misses the > opportunity to let the readers discover what that mode truly is and > what it can do. Yeah, this could probably use a bit of expansion too. It does a reasonable job of explaining why you'd use it in a programming mode, but that's (arguably) already obvious from the name.