Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs unclear on usage of default spell mappings #79

Open
cincodenada opened this issue Jan 7, 2022 · 0 comments
Open

Docs unclear on usage of default spell mappings #79

cincodenada opened this issue Jan 7, 2022 · 0 comments

Comments

@cincodenada
Copy link

cincodenada commented Jan 7, 2022

Hello! Thanks for making this, it's been so useful - spell checking that doesn't account for camelCase is useless to me, so it's so nice to have spell checking again :)

I have a small question: from reading the docs, particularly Section 3.2 of the README where it says (emphasis mine):

Spelunker.vim use Vim spell commands as default. You can also add word under cursor to spellfile with the following commands:

" Add selected word to spellfile
" zg =>
Zg

[...and so on...]

Reading that, I expect that I can just use the regular Vim spell commands if I :set nospell and then use Spelunker.

That isn't the case, at least in my install - the usual spell commands (starting with a lowercase z) do nothing in normal mode. Looking at the plugin source, the only place I see any of the lower-case commands (besides documentation) is a mapping for add-spelunker-good/bad that I think is executing zg/zw. I don't know if I'm missing some other hooks that should be firing or something.

So depending on what is expected to happen, I'm seeing either a documentation bug (docs imply that Spelunker should work out of the box with the default vimspell bindings when it shouldn't), or a functionality bug (it should work with the default bindings, but doesn't).

What is the intended behavior here? Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant