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(README.md): Add human readable description to keymap #3276

Merged
merged 2 commits into from
Sep 18, 2024

Conversation

rodrigc
Copy link
Contributor

@rodrigc rodrigc commented Sep 3, 2024

Description

In the readme, I think it would be nice to add human readable descriptions to the keymaps.

See: https://neovim.io/doc/user/lua.html#vim.keymap.set()

and documentation for the desc parameter:
https://neovim.io/doc/user/api.html#nvim_set_keymap()

This makes the output for tools like which-key.nvim look nicer.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Configuration:

  • Neovim version (nvim --version):
NVIM v0.10.1
Build type: Release
LuaJIT 2.1.1720049189
Run "nvim -V1 -v" for more info
  • Operating system and version:
macOS 14.6.1

Checklist:

  • My code follows the style guidelines of this project (stylua)
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (lua annotations)

@rodrigc rodrigc changed the title Add human readable description to keymap docs(README.md): Add human readable description to keymap Sep 3, 2024
README.md Outdated Show resolved Hide resolved
Co-authored-by: James Trew <[email protected]>
@jamestrew jamestrew merged commit 0df05c9 into nvim-telescope:master Sep 18, 2024
12 checks passed
@jamestrew
Copy link
Contributor

thanks!

@jamestrew jamestrew added the backport-0.1.x PR to be backported to 0.1.x (Neovim 0.7 compat) label Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-0.1.x PR to be backported to 0.1.x (Neovim 0.7 compat)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants