summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorChris A James <christophosaurus@gmail.com>2021-11-20 10:03:52 +0000
committerGitHub <noreply@github.com>2021-11-20 11:03:52 +0100
commit7493f51700c442db5b7f44b3c1b92d09148773a5 (patch)
tree6c7a37905bbfa0455629eacc1a1a9ea1609302f3 /CONTRIBUTING.md
parentd686fb27998fc130f7b851fb6c540f3f1fe806e8 (diff)
docs: fix some spelling & grammar (#1475)
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5da7d76..b335e2c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -6,7 +6,7 @@ Thanks for taking the time to submit code to Telescope if you're reading this! W
## Documentation with treesitter
-We are generating docs based on the tree sitter syntax tree. TJ wrote a grammar that includes the documentation in this syntax tree so we can do take this function header documentation and transform it into vim documentation. All documentation that is part of the returning module will be exported. So example:
+We are generating docs based on the tree sitter syntax tree. TJ wrote a grammar that includes the documentation in this syntax tree so we can do take this function header documentation and transform it into vim documentation. All documentation that is part of the returning module will be exported. For example:
```lua
local m = {}
@@ -37,7 +37,7 @@ This guide contains all annotations and we will update it when we add new annota
## What is missing?
-The docgen has some problems on which people can work. This would happen in https://github.com/tjdevries/tree-sitter-lua and documentation of some modules here.
+The docgen has some problems on which people can work. This would happen in [https://github.com/tjdevries/tree-sitter-lua](https://github.com/tjdevries/tree-sitter-lua) and documentation of some modules here.
I would suggest we are documenting lua/telescope/builtin/init.lua rather than the files itself. We can use that init.lua file as "header" file, so we are not cluttering the other files.
How to help out with documentation: