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

Adding FINGenLuaDocSumneko Command #313

Closed
wants to merge 18 commits into from

Conversation

derFreemaker
Copy link
Contributor

@derFreemaker derFreemaker commented Jun 2, 2024

FINGenLuaDocSumneko does the the samething as FinGenLuaDoc but for the Sumneko Language Server.

Also adds documentation for computer, component, event, filesystem and some other things.
The documentation for that is written by hand though to not modify any code. Since this is not asked for or talked about.

Added Features

Adds Signals that are marked deprecated in order to give feedback to the user. Also gives you an usage example with every Signal which is customized to the Signal.

FIN_Operator_* are mapped to ---@operator * this can though throw an exception if FIN_Operator_* is not supported (FIN_Operator_Equals, FIN_Operator_LessThan, FIN_Operator_LessOrEqualThan, FIN_Operator_Index, FIN_Operator_NewIndex), since there is no equivalent operator naming in sumneko, are also not used currently and only cause a game crash when executing the command (there for not game breaking).

@derFreemaker derFreemaker marked this pull request as ready for review June 2, 2024 14:41
@derFreemaker derFreemaker marked this pull request as draft June 2, 2024 14:52
@derFreemaker derFreemaker marked this pull request as ready for review June 2, 2024 14:55
@RozeDoyanawa
Copy link
Collaborator

You used the wrong branch as the base I think. Should have been development.

@derFreemaker
Copy link
Contributor Author

derFreemaker commented Jun 3, 2024

well, it says development on both sides:
"into Panakotta00/development from derFreemaker/development"
I dont see how the base matters any way since I am adding two files.

@RozeDoyanawa
Copy link
Collaborator

RozeDoyanawa commented Jun 4, 2024

It doesn't. However, I can't/won't approve pull requests from others than me. But from experience, pana is never going to approve code which includes files/resources named with references to the maker. Its ok to include author and written by and such, but the file names, classes and variables should be free of creator-references and rather be named solely by purpose.

@derFreemaker
Copy link
Contributor Author

I see what you mean, I hadn't thought of it since there is EmmyLua and the Lua LSP of Sumneko, so I just consider it SumnekoLua. I guess I could replace Sumneko with “2” everywhere. It just makes it a bit ugly in terms of naming. I just don't have a better name for it since it's for the Lua LSP of Sumneko. If you have a suggestion, I'm open to it.

@RozeDoyanawa
Copy link
Collaborator

Oh, I did not realize it was the name of the plugin... non the less, names like just lua markdown export or something is probably better. Dunno how much EmmyLUA and sumneko differs, so cant judge. I guess Pana will have to put a word in eventually :)

@derFreemaker
Copy link
Contributor Author

Well, it only generates Lua files with metadata, otherwise I would use markdown or something else, but since FINGenLuaDoc is short for FicsIt-NetworksGenerateLuaDocumentation. And the Lua LSP from Sumneko is EmmyLua with extra features (e.g.: ---@operator), so there is not much difference between the two. I guess I'll have to wait for Panakotta to check it out.

@derFreemaker
Copy link
Contributor Author

derFreemaker commented Jun 14, 2024

Moving this PR into another branch since its blocking my development branch.

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.

2 participants