From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#30998: 27.0.50; The Help for defclass with multiline documentation is very hard to read Date: Sun, 14 Jul 2019 15:35:19 +0200 Message-ID: <87a7dgu4bs.fsf@mouse.gnus.org> References: Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="30796"; mail-complaints-to="usenet@blaine.gmane.org" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux) Cc: 30998@debbugs.gnu.org To: Xu Chunyang Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sun Jul 14 15:36:08 2019 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1hmeff-0007oE-LO for geb-bug-gnu-emacs@m.gmane.org; Sun, 14 Jul 2019 15:36:07 +0200 Original-Received: from localhost ([::1]:60532 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hmefe-0001SZ-GR for geb-bug-gnu-emacs@m.gmane.org; Sun, 14 Jul 2019 09:36:06 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:37769) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hmefb-0001Ry-FM for bug-gnu-emacs@gnu.org; Sun, 14 Jul 2019 09:36:04 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hmefa-0001F5-8Y for bug-gnu-emacs@gnu.org; Sun, 14 Jul 2019 09:36:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:35197) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hmefa-0001Ew-4j for bug-gnu-emacs@gnu.org; Sun, 14 Jul 2019 09:36:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1hmefa-0002uL-1G for bug-gnu-emacs@gnu.org; Sun, 14 Jul 2019 09:36:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 14 Jul 2019 13:36:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 30998 X-GNU-PR-Package: emacs Original-Received: via spool by 30998-submit@debbugs.gnu.org id=B30998.156311132711117 (code B ref 30998); Sun, 14 Jul 2019 13:36:01 +0000 Original-Received: (at 30998) by debbugs.gnu.org; 14 Jul 2019 13:35:27 +0000 Original-Received: from localhost ([127.0.0.1]:44013 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hmef0-0002tD-Mz for submit@debbugs.gnu.org; Sun, 14 Jul 2019 09:35:26 -0400 Original-Received: from quimby.gnus.org ([80.91.231.51]:51840) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hmeey-0002t4-E8 for 30998@debbugs.gnu.org; Sun, 14 Jul 2019 09:35:24 -0400 Original-Received: from cm-84.212.202.86.getinternet.no ([84.212.202.86] helo=marnie) by quimby.gnus.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1hmeeu-0002dD-2h; Sun, 14 Jul 2019 15:35:22 +0200 In-Reply-To: (Xu Chunyang's message of "Sat, 31 Mar 2018 03:38:29 +0800") X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 209.51.188.43 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.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:162980 Archived-At: Xu Chunyang writes: > I don't know if defclass requires that :documentation must occupies just > a single line. Helm uses many multiple lines string for that slot, please= see > > https://github.com/emacs-helm/helm/blob/6a34d57f416e4194e6d3207b558d3a00c= df2b955/helm-source.el#L54 > > 'C-h f helm-source' is very hard to read, the following is a part of *Hel= p* For a build-in example, see `C-h f registry-db' (included below). So the problem here is with the :documentation strings for the slots: They can be multi-line, and `C-h f' should format that situation different. But even with single-line descriptions, it's unreadable, really, unless you have an Emacs window that's 150 characters wide. Perhaps this should be reformatted completely, with the :documentation string on a separate line? ---- Class description: registry-db is a type (of kind =E2=80=98eieio--class=E2=80=99) in =E2=80=98= registry.el=E2=80=99. Inherits from =E2=80=98eieio-persistent=E2=80=99. Instance Allocated Slots: Name Type Default Doc =E2=80=94=E2=80=94=E2=80=94=E2=80=94 =E2=80=94=E2=80=94=E2=80=94=E2=80=94 = =E2=80=94=E2=80=94=E2=80=94=E2=80=94=E2=80=94=E2=80=94=E2=80=94 =E2=80=94= =E2=80=94=E2=80=94 file string unbound The save file for this persistent object. This must be a string, and must be specified when the new object is instantiated. version (or null float) nil The registry version. max-size integer (symbol-value 'most-positive-fixnum) The maximum number o= f registry entries. prune-factor float 0.1 Prune to (:max-size * :prune-factor) less than the :max-size limit. Should be a float between 0 and 1. tracked t nil The tracked (indexed) fields, a list of symbols. precious t nil The precious fields, a list of symbols. tracker hash-table unbound The field tracking hash table. data hash-table unbound The data hash table. ---- --=20 (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no