Documentation for lgi
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 491
- Forks
- 81
- PR merge metrics
- No merged PRs in 30d
Description
I have been using lgi for one of my projects, and it has been incredibly difficult for me to wrap my head around it. There aren't any documents for it, and the only way for me to make a program with lgi that uses dbus, is to look at other people's code, and Gio documents that are authored for C, then write my own code, and make it work with a lot of trial and error. Is there any better way to to do this? Any time a GLib.Variant value is returned, I have to fiddle around with it for a long time, and then finally find out what value it actually stored. I'm amazed that there isn't any documentation for the simplest operations with lgi and dbus.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by identifying the simplest lgi and D-Bus operations described in the issue, including how GLib.Variant values are inspected and used. Review relevant lgi usage and Gio-for-C examples, then document equivalent Lua workflows. Done means newcomers can perform these operations without relying on trial and error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100