abo-abo / avy

Jump to things in Emacs tree-style
1.73k stars 110 forks source link

Fix some byte-compiler warnings #360

Closed PuercoPop closed 1 year ago

PuercoPop commented 1 year ago

Hi, thanks for avy.el!

The following PR fixes warnings that show up when byte-compilation. The first one is about how symbols should be quoted in docstrings:

This convention is documented in the Documentation Tips section of the Elisp manual

• When a documentation string refers to a Lisp symbol, write it as it would be printed (which usually means in lower case), with a grave accent ‘`’ before and apostrophe ‘'’ after it. There are two exceptions: write ‘t’ and ‘nil’ without surrounding punctuation.

The second one is about linum-mode not being known to be defined as the require happens when we execute the function.

The only warning that I didn't fix is the following:

In avy--linum-update-window: avy.el:1723:14: Warning: ‘inhibit-point-motion-hooks’ is an obsolete variable (as of 25.1); use ‘cursor-intangible-mode’ or ‘cursor-sensor-mode’ instead

Because using the new variable would mean dropping support for Emacs 24.1. Although I would be ok with that, I'm not sure how you feel about backwards compatibility.

abo-abo commented 1 year ago

Thanks!