fix: correct stale docs — replace keybindings with public API and vimrc wiring#13
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates user-facing documentation to reflect that tabs.vim no longer ships default keybindings, and instead exposes a small public-function API with recommended vimrc wiring and ecosystem integrations.
Changes:
- Replaces the stale “Keybindings” documentation with a “Setup” section and a recommended vimrc copy/paste block.
- Documents the public function API, including optional integrations (fzf.vim and vim-flog).
- Adds documentation for
g:tabs_vim_tabclose_typesand ecosystem buffer-close behavior in both README and:helpdocs.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
README.md |
Replaces keybinding docs with setup guidance, vimrc example mappings, and a Public API table. |
doc/tabs.vim.txt |
Rewrites section 5 as Setup, adds vimdoc tags for public functions, and documents ecosystem buffer-close configuration. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Replace stale keybindings section with public TabsVim_* API table and recommended vimrc wiring block. Add g:tabs_vim_tabclose_types and vim-flog to both README and :help tabs.vim. Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
jesse23
force-pushed
the
docs/update-readme-and-help
branch
from
c5be4f8 to
3def3ad
Compare
jesse23
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
README and help file still documented the old hard-coded keybindings that were removed in ADR-004. This fixes both files to match the current plugin behavior.
What was wrong
Keybindingssection listed bindings (<Tab>,<S-Tab>,<leader>h, etc.) the plugin no longer installsg:tabs_vim_tabclose_typesandvim-flogwere absent from both docs:help tabs.vimhad no vimdoc tags for the publicTabsVim_*functionsWhat changed
README.md: replace stale keybinding list with recommended vimrc copy-paste block and a Public API tabledoc/tabs.vim.txt: rewrite section 5 as Setup (public functions + vimrc wiring), add section 6.3 forg:tabs_vim_tabclose_types, add vimdoc tags for allTabsVim_*functions