GNU bug report logs - #58252
29.0.50; Docstrings generated by defclass may be to wide

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 58252 in the body.
You can then email your comments to 58252 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Jonas Bernoulli <jonas <at> bernoul.li>
To: bug-gnu-emacs <at> gnu.org
Subject: 29.0.50; Docstrings generated by defclass may be to wide
Date: Sun, 02 Oct 2022 16:33:40 +0200

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.

Message #8 received at 58252 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefankangas <at> gmail.com>
To: Jonas Bernoulli <jonas <at> bernoul.li>, 58252 <at> debbugs.gnu.org
Subject: Re: bug#58252: 29.0.50;
 Docstrings generated by defclass may be to wide
Date: Sun, 2 Oct 2022 08:29:26 -0700

Jonas Bernoulli <jonas <at> 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.

Message #13 received at 58252 <at> debbugs.gnu.org (full text, mbox):

From: Jonas Bernoulli <jonas <at> bernoul.li>
To: Stefan Kangas <stefankangas <at> gmail.com>, 58252 <at> debbugs.gnu.org
Subject: Re: bug#58252: 29.0.50; Docstrings generated by defclass may be to
 wide
Date: Sun, 02 Oct 2022 23:17:15 +0200

Stefan Kangas <stefankangas <at> gmail.com> writes:

> Jonas Bernoulli <jonas <at> 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?

Message #16 received at 58252 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefankangas <at> gmail.com>
To: Jonas Bernoulli <jonas <at> bernoul.li>, 58252 <at> debbugs.gnu.org
Subject: Re: bug#58252: 29.0.50;
 Docstrings generated by defclass may be to wide
Date: Mon, 3 Oct 2022 00:06:01 +0200

Jonas Bernoulli <jonas <at> bernoul.li> writes:

> 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
> `----

OK, I think I found the remaining ones (commit 655c92ce4a).

I've tested with the file emacsql-sqlite-builtin.el, dated

    ;; Package-Version: 20220422.1605
    ;; Package-Commit: c6f66f2a94a0c520d5c1028858adc2ab0f959f96

and I can't see any warnings.  Please verify this on your end.

> Maybe the warning should include information about which docstring(s)
> are too wide?

Yes, that would be good.  It's a bit more work though.

Message #19 received at 58252 <at> debbugs.gnu.org (full text, mbox):

From: Jonas Bernoulli <jonas <at> bernoul.li>
To: Stefan Kangas <stefankangas <at> gmail.com>, 58252 <at> debbugs.gnu.org
Subject: Re: bug#58252: 29.0.50; Docstrings generated by defclass may be to
 wide
Date: Mon, 03 Oct 2022 14:28:39 +0200

Stefan Kangas <stefankangas <at> gmail.com> writes:

> Jonas Bernoulli <jonas <at> bernoul.li> writes:
>
>> 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
>> `----
>
> OK, I think I found the remaining ones (commit 655c92ce4a).

Thanks, that fixed the issue for me.

Message #22 received at 58252 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefankangas <at> gmail.com>
To: Jonas Bernoulli <jonas <at> bernoul.li>, 58252 <at> debbugs.gnu.org
Subject: Re: bug#58252: 29.0.50;
 Docstrings generated by defclass may be to wide
Date: Mon, 3 Oct 2022 14:36:09 +0200

close 58252 29.1
thanks

Jonas Bernoulli <jonas <at> bernoul.li> writes:

> Thanks, that fixed the issue for me.

Thanks for testing.  I'm therefore closing this bug report.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.