Documentation - Githubissues

Jengamon / ruwren

A Rustified binding for Wren

Other

40 stars 9 forks source link

Documentation #4

Open Jengamon opened 3 years ago

Jengamon commented 3 years ago

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 commented 10 months ago

TODO:

[ ] Document foreign APIs
- [ ] Document foreign v1 (Class, create_module)
- [ ] Document foreign v2 (WrenObject, wren_impl, wren_module)