Add Lua API docs

[twaritwaikar]

Refering to this JSON data: https://gist.github.com/mikke89/05f0a8a8430b53648118340266c69c68
Generated by this Python script: https://gist.github.com/IronicallySerious/9e998798bbf14e7fd4849067527a1cec

[mikke89]

Thanks a lot!

Let me know what you think of my suggestions. A bit of manual revision as well, and it should be good to go :)

[twaritwaikar]

Alright, the formatting should be okay now. If there are any more changes to that let me know. I will now go through the binding code and try to verify all the docstrings.

[mikke89]

Looks good to me. The only thing that stands out a bit to me is the long table of contents list. Maybe we could section it a bit better. For example "main types" such as LuaRmlUi, Context, Element. And Utilities: Vector, Color. Special elements: ElementFormControlInput etc. These are just suggestions.

[twaritwaikar]

Sure that will be nice. I can break the table into those 3 types manually.

[twaritwaikar]

@mikke89 Sent the first manual review I was able to do. I went over the bindings in the Lua plugin and verified all of them with the docs

[twaritwaikar]

I will be doing another review over all the docs strings to verify that all of them make sense

[mikke89]

Nice work, let me know when you feel it's ready to be merged.

By the way, are you still generating the markdown from your script? If so, it would be nice to include the script and json data into the repository so that it is easy to extend and modify the documentation in the future.

[twaritwaikar]

@mikke89 I have gone over the docstrings once and fixed all the "Python terminology" that I could find (which wasn't translating to Lua as it is very well) and converted them to their Lua counterparts.

It should be okay to merge from my side.

And no, after this commit, I started doing manual changes just because I didn't want to edit the JSON directly since that was a single source of truth I had and the task left was the manual review itself. But anyways, I have now pushed the script and the data in this PR so that it can be used again later if required.

Although I don't see it being used later unless the docs become too out of date with the original API :)

[mikke89]

Alright, thanks a lot!

I figured the script might be useful when we add or modify functions, or perhaps want to change the layout later. At least now we have it just in case it becomes useful :)

I'll merge this very soon. Do you mind if I put the RmlUi MIT license on the python script?

[twaritwaikar]

Sure go ahead :)

…

On Tue, Sep 22, 2020, 16:32 Michael R. P. Ragazzon ***@***.***> wrote: Alright, thanks a lot! I figured the script might be useful when we add or modify functions, or perhaps want to change the layout later. At least now we have it just in case it becomes useful :) I'll merge this very soon. Do you mind if I put the RmlUi MIT license on the python script? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#4 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AHSUAFBTF7R7WEK2UGR2H23SHB73BANCNFSM4RTIXX5Q> .

[mikke89]

Thanks again! This has been a long time on the to-do list.