From: Jonas Bernoulli <jonas@bernoul.li>
To: Stefan Kangas <stefankangas@gmail.com>, 58252@debbugs.gnu.org
Subject: bug#58252: 29.0.50; Docstrings generated by defclass may be to wide
Date: Sun, 02 Oct 2022 23:17:15 +0200 [thread overview]
Message-ID: <875yh2q61w.fsf@bernoul.li> (raw)
In-Reply-To: <CADwFkmm237-Oo7BfLadsUnz8Z_O93nvRHUDNX+ZJe_9p9V_OVw@mail.gmail.com>
Stefan Kangas <stefankangas@gmail.com> writes:
> Jonas Bernoulli <jonas@bernoul.li> writes:
>
>> The docstrings generated by helper functions of defclass are to wide
>> if the name of the class is wide enough. For example, the docstring
>> for `emacsql-sqlite-builtin-connection--eieio-childp' is:
>>
>> ,----
>> | emacsql-sqlite-builtin-connection--eieio-childp is a byte-compiled
>> | Lisp function in `emacsql-sqlite-builtin.el'.
>> |
>> | (emacsql-sqlite-builtin-connection--eieio-childp OBJ)
>> |
>> | Return non-nil if OBJ is an object of type `emacsql-sqlite-builtin-connection' or a subclass.
>> `----
>>
>> This affects at least the --eieio-childp, -child-p, -list-p and -p
>> functions.
>
> Thanks, I pushed a fix for this (commit 0a40120b40). Could you please
> test it?
>
> If it's still not working, please give examples of docstrings where it
> doesn't.
The docstrings of these functions are no longer to wide, but I still get
the same warning,
,----
| In toplevel form:
| emacsql-sqlite-builtin.el:28:5: Warning: docstring wider than 80
| characters
`----
M-x apropos RET emacsql-sqlite-builtin-connection RET gives me
,----
| emacsql-sqlite-builtin-connection
| Function: Create a new object of class type
| Variable: (not documented)
| Value: emacsql-sqlite-builtin-connection
| Properties: cl-deftype-satisfies compiler-macro
| byte-obsolete-variable cl--class variable-documentation
| emacsql-sqlite-builtin-connection--anon-cmacro
| Function: (not documented)
| Properties: function-history
| emacsql-sqlite-builtin-connection--eieio-childp
| Function: Return non-nil if OBJ is an object of type
| emacsql-sqlite-builtin-connection-child-p
| Function: Return non-nil if OBJ is an object of type
| Properties: byte-obsolete-info
| emacsql-sqlite-builtin-connection-list-p
| Function: Test OBJ to see if it a list of objects which are a child
| of type
| Properties: byte-obsolete-info
| emacsql-sqlite-builtin-connection-p
| Function: Return non-nil if OBJ is an object of type
`----
The information that is shown when following the various "Properties"
links is wider than 80 characters, but I wouldn't expect any warning
about that.
Maybe the warning should include information about which docstring(s)
are too wide?
next prev parent reply other threads:[~2022-10-02 21:17 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-10-02 14:33 bug#58252: 29.0.50; Docstrings generated by defclass may be to wide Jonas Bernoulli
2022-10-02 15:29 ` Stefan Kangas
2022-10-02 21:17 ` Jonas Bernoulli [this message]
2022-10-02 22:06 ` Stefan Kangas
2022-10-03 12:28 ` Jonas Bernoulli
2022-10-03 12:36 ` Stefan Kangas
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=875yh2q61w.fsf@bernoul.li \
--to=jonas@bernoul.li \
--cc=58252@debbugs.gnu.org \
--cc=stefankangas@gmail.com \
/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).