love2d icon indicating copy to clipboard operation
love2d copied to clipboard

Maintaining

Open carsakiller opened this issue 2 years ago • 7 comments

Hello,

The definitions in this addon have been generated from https://github.com/LuaLS/lua-language-server/blob/master/tools/love-api.lua by using ./bin/lua-language-server ./tools/build-3rd-meta.lua. This uses https://github.com/love2d-community/love-api.

I would like help with maintaining this addon from someone knowledgeable about love2d. I have never really used it so I am not sure if it would be best to keep generating the documentation from https://github.com/love2d-community/love-api, or to manually update it, or if https://github.com/love2d-community/love-api is even accurate.

If someone could assist with managing issues on this addon and keeping the definitions up to date (using whatever method they think is best), that would be great! 🙂

carsakiller avatar Nov 23 '23 17:11 carsakiller

Hello, I'm one of LOVE Developers.

Our function documentation lives in the wiki https://love2d.org/wiki/Main_Page. Pulling definitions from https://github.com/love2d-community/love-api is correct move since you can't really process that wiki text directly. However if there's discrepancy between the love-api repository and the wiki, our wiki should be used as resolution. This means filling the appropriate issue in love-api repository.

MikuAuahDark avatar Dec 26 '23 05:12 MikuAuahDark

Hello. Please update this add-on to 11.5.

Thanks.

gphg avatar Jul 04 '24 12:07 gphg

There's no functions added in 11.5, so it's unnecessary to update.

MikuAuahDark avatar Jul 04 '24 13:07 MikuAuahDark

It is missing love.handlers.

gphg avatar Jul 04 '24 14:07 gphg

love.handlers is implementation detail, not having it documented is good.

MikuAuahDark avatar Jul 04 '24 15:07 MikuAuahDark

I see.

I recheck the API and compared it myself, it is confirmed there are new functions. Although there are no new subjects, the information of existing subject seem out to dated and need to be updated.

I managed to updated it to latest commit of API myself. I don't how other are— or does it really bother them.

I don't plant to make a PR, but feel free to make one.

gphg avatar Jul 05 '24 03:07 gphg

After some consideration, I plan on taking over the definitions files to love-community/love-api with Python-based generator script. This to ensure that latest definition are automatically generated. Is it fine? What are the steps needed to upstream the new definition files to Lua Addons Manager?

MikuAuahDark avatar Dec 24 '24 12:12 MikuAuahDark