-
-
Notifications
You must be signed in to change notification settings - Fork 260
Generate DOC.md from annotations
#1353
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
Merged
Changes from 1 commit
Commits
Show all changes
61 commits
Select commit
Hold shift + click to select a range
90ef60a
refactor: put all api-function into their own class.
L3MON4D3 af1420c
Add more documentation.
L3MON4D3 91dddd0
doc: add code for generating docstrings from annotations.
L3MON4D3 c314824
gitignore build artifacts from doc.
L3MON4D3 b7abead
finish doc for init.lua, document ChoiceNode.C, update luals-mdgen.
L3MON4D3 8b327ce
remove doc.json, is build artifact.
L3MON4D3 79e7ab1
ci: add DOC.md-generation to push workflow.
L3MON4D3 aec181e
whoops!
L3MON4D3 f34a4ac
remove old comment.
L3MON4D3 8605dc1
nix: update luals-mdgen.
L3MON4D3 58b431d
make sure there are empty lines before any lists.
L3MON4D3 0d86256
update dictionary.
L3MON4D3 6948930
ci: use aspell directly for running spellcheck.
L3MON4D3 5130823
move DOC-template.md into ./data/.
L3MON4D3 ea7ba6d
doc: specify special-case of textNode as a choice.
L3MON4D3 7113cfe
ci: fix spell workflow.
L3MON4D3 c334ff1
update luals-mdgen.
L3MON4D3 678b5bf
spellcheck: set locale-dependent encoding, fix spellcheck_interactive.
L3MON4D3 0b37dca
Auto generate docs
L3MON4D3 592a634
Format with stylua
L3MON4D3 9659b9d
doc: add panvimdoc and vimdoc make-step, use in ci.
L3MON4D3 a3e75ee
re-generate doc.
L3MON4D3 9611fc1
doc: don't be too verbose about return-values.
L3MON4D3 964cff2
doc: add newlines in long doc-blocks.
L3MON4D3 338d9a9
Auto generate docs
L3MON4D3 6e9fc6d
doc: s/--/---/
L3MON4D3 357800b
doc: make sure class-doc is above @class.
L3MON4D3 e15ad06
annotations: replace table<x,y> with {[x]: y}.
L3MON4D3 5857a31
annotations: make type a bit more strict.
L3MON4D3 407ebb9
regenerate doc.
L3MON4D3 ac1ee19
update helptags after updating vimdoc.
L3MON4D3 06e6084
use panvimdoc-fork.
L3MON4D3 cdeed19
annotations: add return-type for get_snip_env.
L3MON4D3 11a250d
generate api-doc as subsubsubheadings.
L3MON4D3 8484341
panvimdoc: drop unnecessary flag.
L3MON4D3 b9e6223
doc: generate DOC.md once with panvimdoc-links, once without.
L3MON4D3 bec3c1b
doc: add empty line before list.
L3MON4D3 0c90008
doc: generate documentation before running luals-mdgen.
L3MON4D3 c49fdb2
doc: update luals-mdgen.
L3MON4D3 4bf7206
LuaSnip.Choice -> LuaSnip.ChoiceNode.ItemNode.
L3MON4D3 da6eee4
Few annotations tweaks
bew e0b81c1
Include changes for the other comments on #1353
bew 4bfc49c
Apply suggestions
bew 62c62e9
Add in-comment indent in doc annotations for top-doc & line continuation
bew ae20fa1
re-generate doc.
L3MON4D3 f5cdf05
add missing annotations.
L3MON4D3 707f89e
update luals-mdgen.
L3MON4D3 b0fdce2
add one last missing parameter.
L3MON4D3 3ccbb4f
shuffle around choiceNode doc.
L3MON4D3 a70f977
update luals-mdgen.
L3MON4D3 a47e5aa
make sure links are formatted correctly.
L3MON4D3 cd0f3c4
add missing newline before list.
L3MON4D3 5be06e2
update panvimdoc.
L3MON4D3 68faade
upate luals-mdgen.
L3MON4D3 fe21c82
update luals-mdgen.
L3MON4D3 fb4b3fa
update panvimdoc.
L3MON4D3 d8cee89
doc: briefly expand how to create a `LuaSnip.Addable`.
L3MON4D3 fbbd855
doc: add missing explanation for clean_invalidated-opts.
L3MON4D3 c9f081a
update panvimdoc.
L3MON4D3 75baad0
doc: render vimdoc-markdown with textwidth 80.
L3MON4D3 bd39313
doc: remove conflicting `LuaSnip.Snippet` definition.
L3MON4D3 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.