mattwparas / steel

An embedded scheme interpreter in Rust
Apache License 2.0
980 stars 46 forks source link

docs for several builtins #206

Closed jrvidal closed 2 months ago

jrvidal commented 2 months ago

I added a few docs for several builtins. Each commit in this PR is pretty isolated, to help with review. I'm not totally sure what's the end format we're striving for, e.g.

(foo n)

* n : int?

vs.

(foo int?)

so I've winged it a little bit.

:question: Should I run docgen and commit the generated markdown as well?

mattwparas commented 2 months ago

To answer your question - Yes if you could run the docgen task and commit that would be great!