GNU logs - #58854, boring messages

Message sent to bug-gnu-emacs@HIDDEN:


X-Loop: help-debbugs@HIDDEN
Subject: bug#58854: [WISH] Could *Help* buffers provide information about :type of defcustoms?
Resent-From: Ihor Radchenko <yantar92@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Sat, 29 Oct 2022 02:25:02 +0000
Resent-Message-ID: <handler.58854.B.16670102539130 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
X-GNU-PR-Message: report 58854
X-GNU-PR-Package: emacs
X-GNU-PR-Keywords: 
To: 58854 <at> debbugs.gnu.org
X-Debbugs-Original-To: bug-gnu-emacs@HIDDEN
Received: via spool by submit <at> debbugs.gnu.org id=B.16670102539130
          (code B ref -1); Sat, 29 Oct 2022 02:25:02 +0000
Received: (at submit) by debbugs.gnu.org; 29 Oct 2022 02:24:13 +0000
Received: from localhost ([127.0.0.1]:34663 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1oobW8-0002NC-IU
	for submit <at> debbugs.gnu.org; Fri, 28 Oct 2022 22:24:12 -0400
Received: from lists.gnu.org ([209.51.188.17]:36046)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <yantar92@HIDDEN>) id 1oobW4-0002N1-2O
 for submit <at> debbugs.gnu.org; Fri, 28 Oct 2022 22:24:11 -0400
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 <yantar92@HIDDEN>)
 id 1oobVz-0004fC-U9
 for bug-gnu-emacs@HIDDEN; Fri, 28 Oct 2022 22:24:04 -0400
Received: from mout01.posteo.de ([185.67.36.65])
 by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <yantar92@HIDDEN>)
 id 1oobVx-0006Pm-Oy
 for bug-gnu-emacs@HIDDEN; Fri, 28 Oct 2022 22:24:03 -0400
Received: from submission (posteo.de [185.67.36.169]) 
 by mout01.posteo.de (Postfix) with ESMTPS id C2BC1240026
 for <bug-gnu-emacs@HIDDEN>; Sat, 29 Oct 2022 04:23:57 +0200 (CEST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017;
 t=1667010239; bh=FXqJtXZEkvtFicWoIBBYsNJDtpDN/+QWsKPa5C8+TtI=;
 h=From:To:Subject:Date:From;
 b=j2SrrHhDipdzp0ysBAIxUXh/WduJYjQV5+IbGtc758My8k55IIYvaBFVHgbXzWe1a
 xQ4TfDW1A6tbcY9qHWrwyGPI/EbINxb3M/RLnlj49IX64pt8tdHy8rvlRr5Nfd0SWX
 f583zLG8K1ZQagY4i6M+AdOiaTkpiiPCXoV2h64PMtsq9vNLO2oiub4NcDar54Rvy2
 X19PcxO2T1l6j1tvEQwWpViwrQKZcgHVnZEG2oKUtlpreOntKnF96mIhti6BVYzHop
 hTT3hAFGilEAaw9DM7RrDDCYBLTl0IiYGEy3XLgdwToe3tZBwlZYmRNdywD/oEIpc5
 5zYIPesKgling==
Received: from customer (localhost [127.0.0.1])
 by submission (posteo.de) with ESMTPSA id 4Mzjs81Fxsz9rxD
 for <bug-gnu-emacs@HIDDEN>; Sat, 29 Oct 2022 04:23:55 +0200 (CEST)
From: Ihor Radchenko <yantar92@HIDDEN>
Date: Sat, 29 Oct 2022 02:24:39 +0000
Message-ID: <87mt9fl63c.fsf@localhost>
MIME-Version: 1.0
Content-Type: text/plain
Received-SPF: pass client-ip=185.67.36.65; envelope-from=yantar92@HIDDEN;
 helo=mout01.posteo.de
X-Spam_score_int: -43
X-Spam_score: -4.4
X-Spam_bar: ----
X-Spam_report: (-4.4 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1,
 DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1,
 RCVD_IN_DNSWL_MED=-2.3, SPF_HELO_NONE=0.001,
 SPF_PASS=-0.001 autolearn=ham autolearn_force=no
X-Spam_action: no action
X-Spam-Score: -1.3 (-)
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -2.3 (--)

Hi,

In Org, we have seen a number of reports when people tried to set
custom variables via setq and used the values that are not recognized.

Such issue commonly occurred when the allowed values were listed in
:type specification, but not in the docstring.

Indeed, one can update the docstring every time :type specification is
changed/added. However, it would be nice if *Help* buffers automatically
listed the allowed variable values according to :type specification.

I propose the following:
1. If a defcustom contains :type keyword, *Help* can add auto-generated
   paragraph describing the allowed values:

   The variable can take the following values:
   - <type1 :tag> :: <type1>
     - <subtype :tag> :: <subtype>
     ...
   - <type2 :tag> :: <type2>
   ...
2. The feature can be explicitly disabled by setting :type-doc nil.

WDYT?

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Message sent:


Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-Mailer: MIME-tools 5.505 (Entity 5.505)
Content-Type: text/plain; charset=utf-8
X-Loop: help-debbugs@HIDDEN
From: help-debbugs@HIDDEN (GNU bug Tracking System)
To: Ihor Radchenko <yantar92@HIDDEN>
Subject: bug#58854: Acknowledgement ([WISH] Could *Help* buffers provide
 information about :type of defcustoms?)
Message-ID: <handler.58854.B.16670102539130.ack <at> debbugs.gnu.org>
References: <87mt9fl63c.fsf@localhost>
X-Gnu-PR-Message: ack 58854
X-Gnu-PR-Package: emacs
Reply-To: 58854 <at> debbugs.gnu.org
Date: Sat, 29 Oct 2022 02:25:02 +0000

Thank you for filing a new bug report with debbugs.gnu.org.

This is an automatically generated reply to let you know your message
has been received.

Your message is being forwarded to the package maintainers and other
interested parties for their attention; they will reply in due course.

Your message has been sent to the package maintainer(s):
 bug-gnu-emacs@HIDDEN

If you wish to submit further information on this problem, please
send it to 58854 <at> debbugs.gnu.org.

Please do not send mail to help-debbugs@HIDDEN unless you wish
to report a problem with the Bug-tracking system.

--=20
58854: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D58854
GNU Bug Tracking System
Contact help-debbugs@HIDDEN with problems

Message received at control <at> debbugs.gnu.org:


Received: (at control) by debbugs.gnu.org; 12 Nov 2022 20:45:18 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Sat Nov 12 15:45:18 2022
Received: from localhost ([127.0.0.1]:49210 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1otxNO-0005yL-0Y
	for submit <at> debbugs.gnu.org; Sat, 12 Nov 2022 15:45:18 -0500
Received: from mail-ot1-f47.google.com ([209.85.210.47]:45737)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <stefankangas@HIDDEN>) id 1otxNM-0005am-Be
 for control <at> debbugs.gnu.org; Sat, 12 Nov 2022 15:45:16 -0500
Received: by mail-ot1-f47.google.com with SMTP id
 94-20020a9d0067000000b0066c8d13a33dso4619459ota.12
 for <control <at> debbugs.gnu.org>; Sat, 12 Nov 2022 12:45:16 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112;
 h=to:subject:message-id:date:mime-version:from:from:to:cc:subject
 :date:message-id:reply-to;
 bh=JOoF9fYa1UTjE1e4m4dnFlQzISdQad5Zzi2HWreJPpQ=;
 b=cL+VuGKa3dY/BaXkeWMFkT6KgJZfIhFwxo/5Z4VoHL6XGmHwkufW/aJfdHSdDfhzXI
 3sHUxL84B1to2o94iJh2VcMF9HgmVEU+QJiWjNA6A4vNhqgLfOC61YayvOUkk9Z4KJ8r
 JcwiywAcZG/4ED3xIloNPySUrL4NwQhgIXRdqYZkS8NuHNHTYqIxoT4ENyehA+5fCT7l
 X2YT3E+iJ1YT0J7uU0jzEWa2ksqL7gIOHwINyiFaRFh6vWMi3k9hifjLY1xipod6Ie01
 J/cXR4hb+SCJ4cCIDvVVOv1wvr4PKQcKRpzQGa9a0Zpg9xxRRFJLolL9ofy29zMh0DCv
 HPDg==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20210112;
 h=to:subject:message-id:date:mime-version:from:x-gm-message-state
 :from:to:cc:subject:date:message-id:reply-to;
 bh=JOoF9fYa1UTjE1e4m4dnFlQzISdQad5Zzi2HWreJPpQ=;
 b=8LfDWMVPHNHokJW0r02uylWaMQlyHHpVXFfBPhSE1lpbvnj0h3zzRMAmwYZbHMslaf
 t0k+2vz4wETkGAo2kVaDvaIODU7DYFB1WnRAvl1WhqUD3Z6LLSKTAW6IlG5MjKwUt6/K
 y9yvAgHjvPxf0pOAZED4EJBHc/2JBZtprMmstiVYBZYLyra0SE9s/SOYC0Ej2i5H6q4G
 v4ojuQmnM8yI3XNH9G0ec/raK/vSAs+52/eDW55/PK4tjyHLB7xRExN5CCffexa2qJ4/
 6JMF2iNFO5oP3LRTE1aMClzV/X4QsoP27m6hTnyUncn5KJQnXqoJ3fzmDxeN+VqsWTnJ
 gVyQ==
X-Gm-Message-State: ANoB5pnt/MeV/uLaG/PfWqJZml8EQzN4UYUC7AAh5sKqzG7iZd3gXi6e
 FNQ15YQrd0rb4ZKu02bqSHcq5bqHP0dOg9aEl6IKhHY/
X-Google-Smtp-Source: AA0mqf6Z29a6pMtc1aweC2kDYsUn3xbvckGljKWphKdZqU2yTEgk6GDY4nnxoEyIyAg8W+sUWnL1hBhX2Gw0eQ5PzJ4=
X-Received: by 2002:a9d:4f10:0:b0:66c:5232:b9d1 with SMTP id
 d16-20020a9d4f10000000b0066c5232b9d1mr3729574otl.224.1668285910830; Sat, 12
 Nov 2022 12:45:10 -0800 (PST)
Received: from 753933720722 named unknown by gmailapi.google.com with
 HTTPREST; Sat, 12 Nov 2022 12:45:10 -0800
From: Stefan Kangas <stefankangas@HIDDEN>
X-Hashcash: 1:20:221112:control <at> debbugs.gnu.org::LBOAI8+QaBG8wBHt:5D0B
MIME-Version: 1.0
Date: Sat, 12 Nov 2022 12:45:10 -0800
Message-ID: <CADwFkm=1Scd7Xq6oBxqi5tF7fy1_7_QOCzFC9ZxPrBnpGuaXDw@HIDDEN>
Subject: control message for bug #58854
To: control <at> debbugs.gnu.org
Content-Type: text/plain; charset="UTF-8"
X-Spam-Score: 0.0 (/)
X-Debbugs-Envelope-To: control
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.0 (-)

severity 58854 wishlist
quit
Last modified: Sat, 12 Nov 2022 21:00:01 UTC

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997 nCipher Corporation Ltd, 1994-97 Ian Jackson.