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

Expand documentation #25

Open
Tracked by #32
natecraddock opened this issue Aug 11, 2023 · 1 comment
Open
Tracked by #32

Expand documentation #25

natecraddock opened this issue Aug 11, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@natecraddock
Copy link
Owner

natecraddock commented Aug 11, 2023

Now that I am finally consistently using Ziglua I am beginning to be annoyed at the terse documentation. It forces me to jump between the Lua docs and the Ziglua docs frequently. Now, Ziglua will never fully document the entire reference manual, but we can do better.

Update the docs to contain all needed information from the Lua docs. This includes the possible errors, push/pop from stack information, etc.

Completing this is a prerequisite for future changes. Adding or fixing code across the 4 Lua versions is tedious and while this will be a lot of work, it will pay off and make future work much easier.

@natecraddock natecraddock added this to the 0.3.0 milestone Aug 11, 2023
@natecraddock natecraddock changed the title Remove duplication in the libraries Expand documentation Oct 2, 2023
@natecraddock natecraddock added the documentation Improvements or additions to documentation label Dec 29, 2023
@natecraddock natecraddock mentioned this issue Dec 29, 2023
10 tasks
@nurpax
Copy link
Contributor

nurpax commented Jan 6, 2024

Suggestion: it'd be good to have example code on how to log the error messages coming from Lua, like when invoking code with pcall. Maybe even add some sort utility function that automatically turns on logging them (or utility for pcall that logs?)

@natecraddock natecraddock removed this from the 0.3.0 milestone Jan 13, 2024
natecraddock added a commit that referenced this issue Oct 13, 2024
Still a work in progress

See #25
natecraddock added a commit that referenced this issue Oct 20, 2024
Still a work in progress

See #25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants