From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Ihor Radchenko Newsgroups: gmane.emacs.bugs Subject: bug#58854: [WISH] Could *Help* buffers provide information about :type of defcustoms? Date: Sat, 29 Oct 2022 02:24:39 +0000 Message-ID: <87mt9fl63c.fsf@localhost> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="27129"; mail-complaints-to="usenet@ciao.gmane.io" To: 58854@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Oct 29 04:25:14 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 1oobX7-0006sk-Sc for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 29 Oct 2022 04:25:13 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oobWz-0004rn-79; Fri, 28 Oct 2022 22:25:05 -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 1oobWx-0004rZ-EV for bug-gnu-emacs@gnu.org; Fri, 28 Oct 2022 22:25:03 -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 1oobWx-0006VI-6D for bug-gnu-emacs@gnu.org; Fri, 28 Oct 2022 22:25:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1oobWw-0002ON-LL for bug-gnu-emacs@gnu.org; Fri, 28 Oct 2022 22:25:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Ihor Radchenko Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 29 Oct 2022 02:25:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 58854 X-GNU-PR-Package: emacs X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.16670102539130 (code B ref -1); Sat, 29 Oct 2022 02:25:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 29 Oct 2022 02:24:13 +0000 Original-Received: from localhost ([127.0.0.1]:34663 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1oobW8-0002NC-IU for submit@debbugs.gnu.org; Fri, 28 Oct 2022 22:24:12 -0400 Original-Received: from lists.gnu.org ([209.51.188.17]:36046) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1oobW4-0002N1-2O for submit@debbugs.gnu.org; Fri, 28 Oct 2022 22:24:11 -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 1oobVz-0004fC-U9 for bug-gnu-emacs@gnu.org; Fri, 28 Oct 2022 22:24:04 -0400 Original-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 ) id 1oobVx-0006Pm-Oy for bug-gnu-emacs@gnu.org; Fri, 28 Oct 2022 22:24:03 -0400 Original-Received: from submission (posteo.de [185.67.36.169]) by mout01.posteo.de (Postfix) with ESMTPS id C2BC1240026 for ; 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== Original-Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4Mzjs81Fxsz9rxD for ; Sat, 29 Oct 2022 04:23:55 +0200 (CEST) Received-SPF: pass client-ip=185.67.36.65; envelope-from=yantar92@posteo.net; 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-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: , Original-Sender: "bug-gnu-emacs" Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:246475 Archived-At: 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: - :: - :: ... - :: ... 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 . Support Org development at , or support my work at