chore: update lua-resty-websocket library annotations #867
Conversation
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
| the basic resty annotation make by me , you can make pr for this too. |
| @CppCXY hi! Thanks for chiming in. Should I submit duplicate PRs in both repos then? |
| Thanks for your PR, and welcome to follow-up this! |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
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.
👋
This PR updates the annotations for lua-resty-websocket, adding docstrings and parameter definitions from the repo. The objects created by
resty.websocket.serverandresty.websocket.clientare almost the same, so I factored out a lot of the common methods/fields into a class atresty.websocket.I'm new to writing EmmyLua annotations for this language server and don't understand everything yet, so please let me know if there is anything that I should fix regarding formatting, naming conventions, etc. (I think it would be great if there were a contribution/style guide for 3rd party type definitions, to encourage other folks in the community to pitch in).
I do a lot of work on OpenResty, so if you like this PR I will probably follow-up with more :)