* bug#58252: 29.0.50; Docstrings generated by defclass may be to wide
@ 2022-10-02 14:33 Jonas Bernoulli
2022-10-02 15:29 ` Stefan Kangas
0 siblings, 1 reply; 6+ messages in thread
From: Jonas Bernoulli @ 2022-10-02 14:33 UTC (permalink / raw)
To: 58252
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.
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#58252: 29.0.50; Docstrings generated by defclass may be to wide
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
0 siblings, 1 reply; 6+ messages in thread
From: Stefan Kangas @ 2022-10-02 15:29 UTC (permalink / raw)
To: Jonas Bernoulli, 58252
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.
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#58252: 29.0.50; Docstrings generated by defclass may be to wide
2022-10-02 15:29 ` Stefan Kangas
@ 2022-10-02 21:17 ` Jonas Bernoulli
2022-10-02 22:06 ` Stefan Kangas
0 siblings, 1 reply; 6+ messages in thread
From: Jonas Bernoulli @ 2022-10-02 21:17 UTC (permalink / raw)
To: Stefan Kangas, 58252
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?
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#58252: 29.0.50; Docstrings generated by defclass may be to wide
2022-10-02 21:17 ` Jonas Bernoulli
@ 2022-10-02 22:06 ` Stefan Kangas
2022-10-03 12:28 ` Jonas Bernoulli
0 siblings, 1 reply; 6+ messages in thread
From: Stefan Kangas @ 2022-10-02 22:06 UTC (permalink / raw)
To: Jonas Bernoulli, 58252
Jonas Bernoulli <jonas@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.
^ permalink raw reply [flat|nested] 6+ messages in thread* bug#58252: 29.0.50; Docstrings generated by defclass may be to wide
2022-10-02 22:06 ` Stefan Kangas
@ 2022-10-03 12:28 ` Jonas Bernoulli
2022-10-03 12:36 ` Stefan Kangas
0 siblings, 1 reply; 6+ messages in thread
From: Jonas Bernoulli @ 2022-10-03 12:28 UTC (permalink / raw)
To: Stefan Kangas, 58252
Stefan Kangas <stefankangas@gmail.com> writes:
> Jonas Bernoulli <jonas@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.
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2022-10-03 12:36 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
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
2022-10-02 22:06 ` Stefan Kangas
2022-10-03 12:28 ` Jonas Bernoulli
2022-10-03 12:36 ` Stefan Kangas
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).