Any plans for adding more documentation for Rust interface?

[inker0]

I'm talking about documentation about the steel (and steel-derive...) crates here. Currently, the docs coverge in steel-core is only 12% (according to cargo +nightly doc with --show-coverage), which is certainly not ideal.

For example, documentation on how to use Engine::new_raw and how to make it works is missing. I am developing a dotfiles manager in Rust using Steel as an extension config language. I would like to customize how some of the builtin functions work but the current documentation is too messy and it is very hard to find the correct method to use. One specific blockage is that require-builtin requires excatly a builtin module called steel/constants to properly return void (I wonder if there is any way to change this behavior). This is undocumented and require someone to dig into source code to know. The above use case might be a bit niche but enough to show that the documentation is not enough.

Actually, if allowed, I would like to contribute about adding more documentation to crates so that it is more easy to pick up for newcomers. Despite having some experience in Rust, I'm just a newbie in Lisp/Scheme/Steel, so please correct me if I'm wrong.

[mattwparas]

I would appreciate any help with documentation improvements. I do have plans to improve the docs, but there are a lot of things to document so it takes me some time to get around to it.

The raw engine interface is tricky to keep in line with the non raw engine interface, and like you've discovered, some things seem to have slipped through the cracks. In order to make some of the features (such as modules) work, the engine has to have some modules hanging around. It probably needs some scrutiny. I'm happy to take a look and work on improving that.

That being said, if you have other specific issues feel free to open issues for those directly as well. The void constants one can probably be fixed pretty easily.

[inker0]

Thank you for your reply!