From: "T.V Raman" <raman@google.com>
To: stefankangas@gmail.com
Cc: raman@google.com, emacs-devel@gnu.org
Subject: Re: Please fix source of unfixable docstring length warnings
Date: Sun, 9 Jan 2022 06:50:22 -0800 [thread overview]
Message-ID: <25050.63022.295691.739844@retriever.mtv.corp.google.com> (raw)
In-Reply-To: <CADwFkmkusmR=Dw6E_5XMYqs0-iEudcZGetLEGwyLonZ5EO413Q@mail.gmail.com>
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 🦮
next prev parent reply other threads:[~2022-01-09 14:50 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
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 [this message]
2022-01-09 15:16 ` 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=25050.63022.295691.739844@retriever.mtv.corp.google.com \
--to=raman@google.com \
--cc=emacs-devel@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).