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

Request: More exaustive tealr docgen example would be nice #102

Open
ConnorBP opened this issue Feb 3, 2024 · 1 comment
Open

Request: More exaustive tealr docgen example would be nice #102

ConnorBP opened this issue Feb 3, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@ConnorBP
Copy link
Contributor

ConnorBP commented Feb 3, 2024

The documentation generation example isn't remarkably clear about what exactly gets auto generated. Also it does not show any example of submodules.

A demonstration of some of the libraries capabilities would be most useful, without it I am trying to figure out how the library is designed by throwing shit at the wall and seeing what sticks. This is rather tiring.

There is also no demo of methods or fields + setters and getters.

@makspll
Copy link
Owner

makspll commented Feb 3, 2024

Hi ConnorBP, appreciate all the issues!

Yes this repo is in dire need of better docs, I would appreciate PR's in this direction, what might help is this github pages doc:
https://github.com/makspll/bevy_mod_scripting_lua (deployed at https://makspll.github.io/bevy_mod_scripting_lua/latest/), you can see how the docs look like for the Bevy API provider.
have a look at our CD which deploys on releases to there automatically and will give you a better idea of how it works.

@makspll makspll added the documentation Improvements or additions to documentation label Apr 5, 2024
@makspll makspll added this to the 2024 Goals milestone Apr 5, 2024
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