nvim-treesitter / nvim-treesitter/nvim-treesitter-textobjects
Document how to do manual mappings
Nobody has claimed this yet.
- Dominant language
- Tree-sitter Query
- Stars
- 2.8k
- Forks
- 271
- Avg merge
- 8d 8h
- Merged PRs (30d)
- 1
Description
Is your feature request related to a problem? Please describe.
It is just a documentation matter. It will be awesome if there were docs about how to do the maps yourself. Currently the only documented way is through config options, but there are advanced scenarios that are not possible this way
Describe the solution you'd like
A explanation about how to do it with some examples. I can provide some examples already.
Describe alternatives you've considered
I just read the source code and figured it out
Additional context
The sky is the limit when you have the power to invoke functions!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the source code that implements manual mappings, since the issue gives no file or test path. Document how to define mappings for advanced scenarios beyond configuration options, including practical examples; the work is done when a newcomer can follow the documentation without needing to infer the process from source.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100