From: "Clément Pit-Claudel" <cpitclaudel@gmail.com>
To: emacs-devel@gnu.org
Subject: Re: Poor quality documentation in edebug.el, and recursive documentation.
Date: Tue, 5 May 2020 17:11:43 -0400 [thread overview]
Message-ID: <6674ab3a-9107-d59f-5758-2fd5961cfbcc@gmail.com> (raw)
In-Reply-To: <20200505202048.GA15482@ACM>
As far as I know, there's no way to provide documentation for a slot of a cl-defstruct. This sounds like a reasonable feature request (you're looking at an auto-generated docstring).
> I certainly care about what this function does, and the one liner is
> gibberish. "Access slot "def-name" of ‘edebug--frame’ struct CL-X."
Really? You're looking at the documentation of a field accessor — can it be made much better (sort of writing it by hand)? It's really the same as the following C function, assuming a struct called "backtrace" with a field called "def_name":
def_name_t backtrace_def_name (backtrace) { return backtrace.def_name }
next prev parent reply other threads:[~2020-05-05 21:11 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-05 20:20 Poor quality documentation in edebug.el, and recursive documentation Alan Mackenzie
2020-05-05 20:39 ` Drew Adams
2020-05-05 21:11 ` Clément Pit-Claudel [this message]
2020-05-06 17:01 ` Alan Mackenzie
2020-05-06 18:20 ` Stefan Monnier
2020-05-06 18:34 ` Eli Zaretskii
2020-05-08 19:59 ` Alan Mackenzie
2020-05-09 5:53 ` Eli Zaretskii
2020-05-09 13:47 ` Stefan Monnier
2020-05-09 13:53 ` Eli Zaretskii
2020-05-09 14:56 ` Alan Mackenzie
2020-05-09 15:06 ` tomas
2020-05-09 15:12 ` Andreas Schwab
2020-05-09 15:11 ` Eli Zaretskii
2020-05-06 18:26 ` Stefan Monnier
2020-05-05 22:18 ` Stefan Monnier
2020-05-08 19:53 ` Alan Mackenzie
2020-05-08 20:24 ` Stefan Monnier
2020-05-12 6:33 ` Madhu
2020-05-12 7:42 ` Eli Zaretskii
2020-05-12 14:04 ` cl-generic misdesign (was: Poor quality documentation in edebug.el, and recursive documentation) Stefan Monnier
2020-05-14 5:03 ` Richard Stallman
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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=6674ab3a-9107-d59f-5758-2fd5961cfbcc@gmail.com \
--to=cpitclaudel@gmail.com \
--cc=emacs-devel@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 public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).