From: Xu Chunyang <mail@xuchunyang.me>
To: 30998@debbugs.gnu.org
Subject: bug#30998: 27.0.50; The Help for defclass with multiline documentation is very hard to read
Date: Sat, 31 Mar 2018 03:38:29 +0800 [thread overview]
Message-ID: <m2y3i973re.fsf@xuchunyang.me> (raw)
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/6a34d57f416e4194e6d3207b558d3a00cdf2b955/helm-source.el#L54
'C-h f helm-source' is very hard to read, the following is a part of *Help*
#+BEGIN_EXAMPLE
Instance Allocated Slots:
Name Type Default Doc
———— ———— ——————— ———
name t nil The name of the source.
A string which is also the heading which appears
above the list of matches from the source. Must be unique.
header-name t nil A function returning the display string of the header.
Its argument is the name of the source. This attribute is useful to
add an additional information with the source name.
It doesn't modify the name of the source.
init t nil Function called with no parameters when helm is started.
It is useful for collecting current state information which can be
used to create the list of candidates later.
Initialization of `candidates-in-buffer' is done here
with `helm-init-candidates-in-buffer'.
#+END_EXAMPLE
It seems Emacs is trying to show everything within a table without
considering :documentation can be long.
next reply other threads:[~2018-03-30 19:38 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-03-30 19:38 Xu Chunyang [this message]
2019-07-14 13:35 ` bug#30998: 27.0.50; The Help for defclass with multiline documentation is very hard to read Lars Ingebrigtsen
2021-06-24 18:25 ` Lars Ingebrigtsen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=m2y3i973re.fsf@xuchunyang.me \
--to=mail@xuchunyang.me \
--cc=30998@debbugs.gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.