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: switch out docgen tool #3227

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

jamestrew
Copy link
Contributor

@jamestrew jamestrew commented Jul 27, 2024

Initial conversion of gendoc to https://github.com/jamestrew/docgen.nvim

main differences from tree-sitter-lua's doc gen:

  • uses luacats annotations instead of emmylua allowing for tighter integration between lua_ls type checking and documentation annotations
  • all descriptions are parsed as markdown using tree-sitter-markdown so improved parsing
  • vimdoc rendering is heavily based off of the code used by neovim core so things will look very similar to neovim core docs

@jamestrew jamestrew force-pushed the docgen branch 2 times, most recently from cae904e to d5d7c39 Compare August 10, 2024 00:21
@jamestrew jamestrew marked this pull request as ready for review August 10, 2024 00:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant