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

Documentation #4

Open
Jengamon opened this issue Nov 22, 2020 · 1 comment
Open

Documentation #4

Jengamon opened this issue Nov 22, 2020 · 1 comment

Comments

@Jengamon
Copy link
Owner

While a lot of the API is meant to resemble that of the Wren API, it's a good idea to just do a documentation pass of the entire library, mainly because of the "magic macros" that remain currently quite undocumented and maybe a bit obtuse (im sorry i mostly just wanted to get things easy and working, so they dont look the prettiest), and to collate the knowledge that's scattered in the 'examples/' directory.

@Jengamon
Copy link
Owner Author

TODO:

  • Document foreign APIs
    • Document foreign v1 (Class, create_module)
    • Document foreign v2 (WrenObject, wren_impl, wren_module)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant