* Please fix source of unfixable docstring length warnings
@ 2022-01-09 2:52 T.V Raman
2022-01-09 8:05 ` Stefan Kangas
0 siblings, 1 reply; 4+ messages in thread
From: T.V Raman @ 2022-01-09 2:52 UTC (permalink / raw)
To: emacs-devel
As an example,
emacspeak-table-ui.el:57:45: Warning: docstring wider than 80
characters
reported on
https://github.com/tvraman/emacspeak/blob/master/lisp/emacspeak-table-ui.el#start-of-content
These warnings are unfixable since the source code doesn't actually
have the problem reported, it appears to happen for things like calls
to define-derived-mode and similar things and the noise from these
spurious warnings means that real warnings will get ignored over time.
--
Thanks,
--Raman(I Search, I Find, I Misplace, I Research)
♉ Id: kg:/m/0285kf1 🦮
--
Thanks,
--Raman(I Search, I Find, I Misplace, I Research)
♉ Id: kg:/m/0285kf1 🦮
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: Please fix source of unfixable docstring length warnings
2022-01-09 2:52 Please fix source of unfixable docstring length warnings T.V Raman
@ 2022-01-09 8:05 ` Stefan Kangas
2022-01-09 14:50 ` T.V Raman
0 siblings, 1 reply; 4+ messages in thread
From: Stefan Kangas @ 2022-01-09 8:05 UTC (permalink / raw)
To: T.V Raman, emacs-devel
[-- Attachment #1: Type: text/plain, Size: 605 bytes --]
"T.V Raman" <raman@google.com> writes:
> As an example,
> emacspeak-table-ui.el:57:45: Warning: docstring wider than 80
> characters
> reported on
> https://github.com/tvraman/emacspeak/blob/master/lisp/emacspeak-table-ui.el#start-of-content
>
> These warnings are unfixable since the source code doesn't actually
> have the problem reported, it appears to happen for things like calls
> to define-derived-mode and similar things and the noise from these
> spurious warnings means that real warnings will get ignored over time.
I can't reproduce this, as the below patch makes the warning go away
here:
[-- Attachment #2: Type: text/plain, Size: 477 bytes --]
Does that patch fix the problem for you too?
I've fixed several warnings for overly long docstrings in automatically
generated strings. If any remain, I would definitely like to find them
and fix them, so I appreciate your help in getting to the root of this.
Thanks.
BTW, if you find these warnings too much of a hassle, you could consider
disabling them with a directory local variable; I believe you would need
to set `byte-compile-warnings' to e.g. `(not docstrings)'.
[-- Attachment #3: fix-warning.diff --]
[-- Type: text/x-diff, Size: 637 bytes --]
diff --git a/lisp/emacspeak-table-ui.el b/lisp/emacspeak-table-ui.el
index 2c1465e0f..0b60769fa 100644
--- a/lisp/emacspeak-table-ui.el
+++ b/lisp/emacspeak-table-ui.el
@@ -85,7 +85,8 @@ T emacspeak-table-goto-top
The next two commands let you search the table.
The commands ask you if you want to search rows or columns.
-When searching headers remember that row 0 is the column header, and that column 0 is the row header.
+When searching headers remember that row 0 is the column header,
+and that column 0 is the row header.
h emacspeak-table-search-headers
s emacspeak-table-search
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: Please fix source of unfixable docstring length warnings
2022-01-09 8:05 ` Stefan Kangas
@ 2022-01-09 14:50 ` T.V Raman
2022-01-09 15:16 ` Stefan Kangas
0 siblings, 1 reply; 4+ messages in thread
From: T.V Raman @ 2022-01-09 14:50 UTC (permalink / raw)
To: stefankangas; +Cc: raman, emacs-devel
I am running emacs built against the latest HEAD, and the error
message in my email was from last evening, so I guess it's not
entirely fixed.
Stefan Kangas writes:
> "T.V Raman" <raman@google.com> writes:
>
> > As an example,
> > emacspeak-table-ui.el:57:45: Warning: docstring wider than 80
> > characters
> > reported on
> > https://github.com/tvraman/emacspeak/blob/master/lisp/emacspeak-table-ui.el#start-of-content
> >
> > These warnings are unfixable since the source code doesn't actually
> > have the problem reported, it appears to happen for things like calls
> > to define-derived-mode and similar things and the noise from these
> > spurious warnings means that real warnings will get ignored over time.
>
> I can't reproduce this, as the below patch makes the warning go away
> here:
>
> ----------------------------------------------------------------------
>
> Does that patch fix the problem for you too?
>
> I've fixed several warnings for overly long docstrings in automatically
> generated strings. If any remain, I would definitely like to find them
> and fix them, so I appreciate your help in getting to the root of this.
> Thanks.
>
> BTW, if you find these warnings too much of a hassle, you could consider
> disabling them with a directory local variable; I believe you would need
> to set `byte-compile-warnings' to e.g. `(not docstrings)'.
>
> ----------------------------------------------------------------------
> diff --git a/lisp/emacspeak-table-ui.el b/lisp/emacspeak-table-ui.el
> index 2c1465e0f..0b60769fa 100644
> --- a/lisp/emacspeak-table-ui.el
> +++ b/lisp/emacspeak-table-ui.el
> @@ -85,7 +85,8 @@ T emacspeak-table-goto-top
>
> The next two commands let you search the table.
> The commands ask you if you want to search rows or columns.
> -When searching headers remember that row 0 is the column header, and that column 0 is the row header.
> +When searching headers remember that row 0 is the column header,
> +and that column 0 is the row header.
>
> h emacspeak-table-search-headers
> s emacspeak-table-search
--
Thanks,
--Raman(I Search, I Find, I Misplace, I Research)
♉ Id: kg:/m/0285kf1 🦮
--
Thanks,
--Raman(I Search, I Find, I Misplace, I Research)
♉ Id: kg:/m/0285kf1 🦮
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: Please fix source of unfixable docstring length warnings
2022-01-09 14:50 ` T.V Raman
@ 2022-01-09 15:16 ` Stefan Kangas
0 siblings, 0 replies; 4+ messages in thread
From: Stefan Kangas @ 2022-01-09 15:16 UTC (permalink / raw)
To: T.V Raman; +Cc: emacs-devel
[-- Attachment #1: Type: text/plain, Size: 363 bytes --]
"T.V Raman" <raman@google.com> writes:
> I am running emacs built against the latest HEAD, and the error
> message in my email was from last evening, so I guess it's not
> entirely fixed.
The patch I sent was for emacspeak-table-ui.el. Could you try
installing it in your tree and see if it resolves your issue?
I have attached it below for your convenience.
[-- Attachment #2: fix-warning.diff --]
[-- Type: text/x-diff, Size: 637 bytes --]
diff --git a/lisp/emacspeak-table-ui.el b/lisp/emacspeak-table-ui.el
index 2c1465e0f..0b60769fa 100644
--- a/lisp/emacspeak-table-ui.el
+++ b/lisp/emacspeak-table-ui.el
@@ -85,7 +85,8 @@ T emacspeak-table-goto-top
The next two commands let you search the table.
The commands ask you if you want to search rows or columns.
-When searching headers remember that row 0 is the column header, and that column 0 is the row header.
+When searching headers remember that row 0 is the column header,
+and that column 0 is the row header.
h emacspeak-table-search-headers
s emacspeak-table-search
^ permalink raw reply related [flat|nested] 4+ messages in thread
end of thread, other threads:[~2022-01-09 15:16 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-01-09 2:52 Please fix source of unfixable docstring length warnings T.V Raman
2022-01-09 8:05 ` Stefan Kangas
2022-01-09 14:50 ` T.V Raman
2022-01-09 15:16 ` Stefan Kangas
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.