From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: =?UTF-8?Q?Jo=C3=A3o_?= =?UTF-8?Q?T=C3=A1vora?= Newsgroups: gmane.emacs.bugs Subject: bug#59954: 29.0.50; flymake-reporting-backends documentation could use some work Date: Sun, 11 Dec 2022 11:36:51 +0000 Message-ID: <87a63ugoj0.fsf@gmail.com> References: Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="18103"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Cc: 59954@debbugs.gnu.org To: Stefan Kangas Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Dec 11 12:36:26 2022 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 1p4Kd8-0004Xi-Rx for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 11 Dec 2022 12:36:26 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1p4Kco-0004xR-T6; Sun, 11 Dec 2022 06:36:06 -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 1p4Kcn-0004xC-5v for bug-gnu-emacs@gnu.org; Sun, 11 Dec 2022 06:36:05 -0500 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 1p4Kck-0006YA-O7 for bug-gnu-emacs@gnu.org; Sun, 11 Dec 2022 06:36:04 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1p4Kck-0000we-El for bug-gnu-emacs@gnu.org; Sun, 11 Dec 2022 06:36:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: =?UTF-8?Q?Jo=C3=A3o_?= =?UTF-8?Q?T=C3=A1vora?= Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 11 Dec 2022 11:36:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 59954 X-GNU-PR-Package: emacs Original-Received: via spool by 59954-submit@debbugs.gnu.org id=B59954.16707585403623 (code B ref 59954); Sun, 11 Dec 2022 11:36:02 +0000 Original-Received: (at 59954) by debbugs.gnu.org; 11 Dec 2022 11:35:40 +0000 Original-Received: from localhost ([127.0.0.1]:46348 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1p4KcO-0000wN-3B for submit@debbugs.gnu.org; Sun, 11 Dec 2022 06:35:40 -0500 Original-Received: from mail-wm1-f54.google.com ([209.85.128.54]:52046) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1p4KcH-0000wG-M2 for 59954@debbugs.gnu.org; Sun, 11 Dec 2022 06:35:38 -0500 Original-Received: by mail-wm1-f54.google.com with SMTP id bg10so2987031wmb.1 for <59954@debbugs.gnu.org>; Sun, 11 Dec 2022 03:35:33 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:user-agent:message-id:date :references:in-reply-to:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=hhtMYCfVhWE9n8wViLv616G+Q8mgX9AZHLSSdfVKsfk=; b=TTQqpbyPwAzMBE0lNrUYyXux2LiJcCWl+5osbwX1do3KY0D2eqHCKQ2aMyZNGNUc5N 5QxeEbsyjMY42bFfpDcuIfBcnVezmExOXGZX+mKdhmBtQniIKp+wwuiGgWfafc243B1L hxXenyE/mP+CwcmXoWFli36CdZzcx2Om0LzMztW+Xn0JrqmqRM7F7yyPZfVGj6KQKzVf 1U1ta+IHlcroqifx1MVAM1CSur7Y5G6PMsx4qfp3CDtrmImBf8Ixb7BISg3cI5DQo1uI kDk9OJdP5wzqp1K6LjlgxoimnR7X7WQxFoS9k0FOY/IzOXH355SjKubLbR41GZYPTWOS lv7A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:user-agent:message-id:date :references:in-reply-to:subject:cc:to:from:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=hhtMYCfVhWE9n8wViLv616G+Q8mgX9AZHLSSdfVKsfk=; b=wn0OGEpICFrxjOiQiSG3vhcKeRPCNSJFhD0vHj5AuX/iNL7jPUNlmQaGYGGeJbJa0n fyXruYd4pCR3zySIfs3Gj6J4WZTGekCIhb28QDIX8FRr9KQtTIPq5MjAVuuo3bZXovVp N4+d44giC/m/VNhUBdcKXUJ/4YN4Q+1MS4n3DEuCrCKSWHdjaUlf6W38e70Hnc9sKQ0G LJYzJtzYwvrMSXstCIeRcVoq8+ByqD1JNrtPhJcuydBSIR6l/mxDJDplXJ6JegNxJ9XV RSu+z9JQbB9iCmly6IZoYQbRbNBncd9lhHjn0bjt0qgCC7V0E/Wiz4ir4QNkRKs3pK1L M6ww== X-Gm-Message-State: ANoB5pnAwPnQoNWMi7b+u77rtcSTSZyF3Fb9HNlJJN/MHlgARTDI3VXQ Oxhzsbt54QmaoEtquHLf0cs8hjQOUPMvUA== X-Google-Smtp-Source: AA0mqf58CmwcIG4Ah5GiSdlFcAIxachKVp5TEd2/HE8uLqcwKc6kNXyGrVJ0R0UztFlAtF3Ky3Aw/Q== X-Received: by 2002:a05:600c:21d8:b0:3d0:8d48:2993 with SMTP id x24-20020a05600c21d800b003d08d482993mr9941139wmj.36.1670758527594; Sun, 11 Dec 2022 03:35:27 -0800 (PST) Original-Received: from krug ([87.196.73.60]) by smtp.gmail.com with ESMTPSA id q11-20020a05600c46cb00b003d1cf67460esm5949893wmo.40.2022.12.11.03.35.26 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 11 Dec 2022 03:35:27 -0800 (PST) In-Reply-To: (Stefan Kangas's message of "Sat, 10 Dec 2022 15:26:18 -0800") 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:250598 Archived-At: Stefan Kangas writes: > On a side note, and not necessarily part of this bug report, it would > also be useful with some documentation that says to find out more about > a particular back-end. Currently, I guess `C-h f' is the recommended > way to do that? Yes. describe-function (C-h f) is the right way because back-ends are represented by functions. You can invent a M-x flymake-describe-backend with a different completion set, but it should funnel to M-x describe-function and give the very same output. On a related note, you can see that in the commands M-x flymake-show-[buffer|project]-diagnostics, the backend's itself is represented in a column. Currently this name is synthesized from the initials of the symbol name bound to the function. This works well as a default, but it could be augmented: For example: * There could be a 'flymake-backend-name' property on the symbols for an extra indirection or better names * Clicking the name in that report could bring up the same thing as C-h f, effectively describing the backend. Jo=C3=A3o