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

Maintaining #4

Open
carsakiller opened this issue Nov 23, 2023 · 7 comments
Open

Maintaining #4

carsakiller opened this issue Nov 23, 2023 · 7 comments
Labels
help wanted Extra attention is needed

Comments

@carsakiller
Copy link
Member

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 carsakiller added the help wanted Extra attention is needed label Nov 23, 2023
@carsakiller carsakiller pinned this issue Nov 23, 2023
@MikuAuahDark
Copy link

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
Copy link

gphg commented Jul 4, 2024

Hello. Please update this add-on to 11.5.

Thanks.

@MikuAuahDark
Copy link

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

@gphg
Copy link

gphg commented Jul 4, 2024

It is missing love.handlers.

@MikuAuahDark
Copy link

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

@gphg
Copy link

gphg commented Jul 5, 2024

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.

@MikuAuahDark
Copy link

MikuAuahDark commented Dec 24, 2024

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants