Use concealed lrv- and love- prefixes; wrap <> for unknown #20
Conversation
This file contains 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
idbrii
added a commit
to idbrii/luarefvim
that referenced
this pull request
Aug 5, 2020
davisdude and I implemented changes to generate the docs properly. davisdude/vim-love-docs#20 Fixes love-function -> lrv-function, love-light userdata -> lrv-lightuserdata, and changes || to <> for undocumented types.
davisdude
reviewed
Aug 5, 2020
Fix undocumented love types (e.g., DisplayOrientation) from being marked with lrv- prefix. Now, those types are wrapped with <> to show that they don't have help. Love types are prefixed with love- to match their tag. LUA_TYPES is pulled from [the manual ](http://www.lua.org/manual/5.4/manual.html#2.1) and those types are the same in 5.1 and 5.4. Added lightuserdata which is used in love docs but unfortunately adds a space so we need to remap to match the lrv tag.
Hide these implementation detail prefixes to make documentation easier to read. Syntax file must be in after/ so it can clobber helpHyperTextJump from vanilla vim help syntax. We generate the after/syntax/ directory, so move the file in the with the gen scripts.
|
I haven't tried on a Windows machine, but I think |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Resolves #19 by building on davisdude's work.
This resolves the No links for love types and Nontypes formatted as types issues I found. I didn't attempt to resolve the issue with Aggregate or multiple possible types.
Adding after/syntax/help.vim required bypassing gitignore. Not sure if you want an alternative solution. I didn't test any syntax changes (I don't use the syntax features of vim-love-docs).