search

dcchambers / vb4c

vb4c has been archived - please direct all conversation to the original cVim project page: https://github.com/1995eaton/chromium-vim
MIT License
141 stars 13 forks source link

documentation out of date? #7

Open DavidGretzschel opened 4 years ago

DavidGretzschel commented 4 years ago

createActiveTabbedHint fullImageHint and I think possibly all "unmapped commands that are described under keybindings: chrome-extension://hgccadbdmponekfeokhpibepjdpfkpja/pages/mappings.html do not autocomplete, nor do they seem to do anything.

That's fine, the important stuff works. But it's a bit discouraging to try out a new command full of anticipation and then wondering whether it's broken or you didn't pay attention to the actual effect. If they are not implemented/ported from cVim yet, could they be grayed out and clearly labelled? And if they are deprecated, could they be appended to the help under a "deprecated"-section?

I'm very excited about vb4c and would like to report bugs/suggest features. cVim has been the most useful extension for me by far. A life changer, and I'm really glad you're picking up its torch. But I don't wish to report a bug and then get a response along the lines of "not implemented yet". It's much harder to test something, if the documentation is out of date.

eastmancr commented 4 years ago

While I do agree that some of the descriptions are a bit ambiguous, both of those commands actually do work. You remap commands by executing map [key] :call [command]<CR>, i.e. map F :call createActiveTabbedHint<CR>. There is nowhere in the mappings page to tell you this, you just have to infer based on the examples they give you. createActiveTabbedHint follows a link to a new tab then makes that the active tab (line #204 of hints.js) by calling chrome.tabs.create with the active bool set, described here. fullImageHint follows an image link to a new tab (line #141 of hints.js) I think the documentation should be combed over to clear up ambiguity and actually instruct users how to remap keys as it is not very obvious in my opinion.

DavidGretzschel commented 4 years ago

Thank you for the helpful explanations. Sounds complicated. Scheduled to look into how to do this.