syl20bnr / spacemacs

A community-driven Emacs distribution - The best editor is neither Emacs nor Vim, it's Emacs *and* Vim!
http://spacemacs.org
GNU General Public License v3.0
23.57k stars 4.9k forks source link

Remove `''` from pdf-outline-buffer-mode-map and update documentation #16316

Closed dankessler closed 3 months ago

dankessler commented 3 months ago

I noticed some noise in my Messages buffer about keybinding whenever I tried to view a PDF, and I tracked it down.

pdf-outline-buffer-mode-map gets evilified. Prior to this, SPC is mapped to pdf-outline-display-link. During evilification, this gets remapped to ' (this remapping is, AFAICT, not documented in evilification but you can see it here (note: 32 means SPC).

We then try to map the key '' to pdf-outline-move-to-current-page, but this isn't possible, because ' is already mapped to a function and is thus not a prefix key.

Fortunately, this behavior is already available via double-backtick: ``.

I've removed the (failed) mapping of '' and also removed it from the documentation.

bcc32 commented 3 months ago

I think it would be great to take this opportunity to also document this behavior in evil-evilified-state.el :)

dankessler commented 3 months ago

It seems it is mentioned in the conventions doc but not in the primary documentation, and I can rectify that.

As far as I know, "evilification" is unique to spacemacs and not a general part of evil; is this correct? I just want to make sure there isn't some "upstream" where I should also make this change. The closest I could find was this repo which looks like it just spliced the code from spacemacs.

dankessler commented 3 months ago

I've pushed another commit that updates the documentation in a few places. I didn't want to squash it, since the two commits are doing rather distinct things, but I can open a separate PR if that is preferred

bcc32 commented 3 months ago

Yeah, as far as I know, evil-evilified-state is unique to Spacemacs.