LuaCATS / love2d

Definitions for the LÖVE 2D game framework
15 stars 4 forks source link

Maintaining #4

Open carsakiller opened 10 months ago

carsakiller commented 10 months ago

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! 🙂

MikuAuahDark commented 9 months ago

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.

gphg commented 3 months ago

Hello. Please update this add-on to 11.5.

Thanks.

MikuAuahDark commented 3 months ago

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

gphg commented 3 months ago

It is missing love.handlers.

MikuAuahDark commented 3 months ago

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

gphg commented 3 months ago

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.