Useful Or spurious: New byte-compiler warnings

Useful Or spurious: New byte-compiler warnings

[T.V Raman]

I recently started getting warnings of the form:

emacspeak-speak.el:2267:2: Warning: docstring has wrong usage of
unescaped single quotes (use \= or different quoting)

Is this truly useful -- or is it spurious and therefore an annoyance
-- I just can tell.

All I can say is that this warning shows up on code that has been
working correctly for a long 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  🦮

Re: Useful Or spurious: New byte-compiler warnings

[Lars Ingebrigtsen]

"T.V Raman" <raman@google.com> writes:

> I recently started getting warnings of the form:
>
> emacspeak-speak.el:2267:2: Warning: docstring has wrong usage of
> unescaped single quotes (use \= or different quoting)
>
> Is this truly useful -- or is it spurious and therefore an annoyance
> -- I just can tell.

It's to warn about things like

    (setq foo '(1 2 3))

in doc strings which turns into invalid code when displayed in *Help*.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Re: Useful Or spurious: New byte-compiler warnings

[T.V Raman]

thanks for the clarification -- sounds useful, but perhaps it could
avoid warning about strings like:
" ...
's' means set.
'e' means erase.
..."
though am not sure how hard checking for corner cases will get.

I did fix all my code relatively quickly so am past it for now 
Lars Ingebrigtsen writes:
 > "T.V Raman" <raman@google.com> writes:
 > 
 > > I recently started getting warnings of the form:
 > >
 > > emacspeak-speak.el:2267:2: Warning: docstring has wrong usage of
 > > unescaped single quotes (use \= or different quoting)
 > >
 > > Is this truly useful -- or is it spurious and therefore an annoyance
 > > -- I just can tell.
 > 
 > It's to warn about things like
 > 
 >     (setq foo '(1 2 3))
 > 
 > in doc strings which turns into invalid code when displayed in *Help*.
 > 
 > -- 
 > (domestic pets only, the antidote for overdose, milk.)
 >    bloggy blog: http://lars.ingebrigtsen.no

-- 

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  🦮

Re: Useful Or spurious: New byte-compiler warnings

[Lars Ingebrigtsen]

"T.V Raman" <raman@google.com> writes:

> thanks for the clarification -- sounds useful, but perhaps it could
> avoid warning about strings like:
> " ...
> 's' means set.
> 'e' means erase.
> ..."
> though am not sure how hard checking for corner cases will get.

Those should be 

> `s' means set.
> `e' means erase.

if they're key strokes.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Re: Useful Or spurious: New byte-compiler warnings

[Stefan Kangas]

Lars Ingebrigtsen <larsi@gnus.org> writes:

> Those should be
>
> > `s' means set.
> > `e' means erase.
>
> if they're key strokes.

In Emacs 29 or later, that could be \\`s' and \\`e' to use the
'help-key-binding' font.

Re: Useful Or spurious: New byte-compiler warnings

[T.V Raman]

The font selection is nice, but we should hide these nits from the
developer.
Stefan Kangas writes:
 > Lars Ingebrigtsen <larsi@gnus.org> writes:
 > 
 > > Those should be
 > >
 > > > `s' means set.
 > > > `e' means erase.
 > >
 > > if they're key strokes.
 > 
 > In Emacs 29 or later, that could be \\`s' and \\`e' to use the
 > 'help-key-binding' font.

-- 

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  🦮

Re: Useful Or spurious: New byte-compiler warnings

[Stefan Kangas]

T.V Raman <raman@google.com> writes:

> The font selection is nice, but we should hide these nits from the
> developer.

I'm not against that, but I don't know how to differentiate between
the symbol `s' and the key `s' here without special markup.

(I should have said the `help-key-binding' "face" rather than "font"
here, sorry.)

Re: Useful Or spurious: New byte-compiler warnings

[T.V Raman]

Understand the issue, but emacs strings already have too many
backslashes
Stefan Kangas writes:
 > T.V Raman <raman@google.com> writes:
 > 
 > > The font selection is nice, but we should hide these nits from the
 > > developer.
 > 
 > I'm not against that, but I don't know how to differentiate between
 > the symbol `s' and the key `s' here without special markup.
 > 
 > (I should have said the `help-key-binding' "face" rather than "font"
 > here, sorry.)

-- 

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  🦮