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

Add doctests, docstrings, and docs #28

Open
gilch opened this issue Sep 15, 2019 · 1 comment
Open

Add doctests, docstrings, and docs #28

gilch opened this issue Sep 15, 2019 · 1 comment

Comments

@gilch
Copy link
Owner

gilch commented Sep 15, 2019

We might need a REPL first. #2. Lissp has doctests.

@gilch
Copy link
Owner Author

gilch commented Sep 26, 2019

A tutorial in the style of learn X in Y minutes might also be good. Especially if we can doctest a REPL session.

I also really like the organization of https://clojure.org/api/cheatsheet, but Hebigo's API isn't that big. Sphinx autodoc like Hissp has may suffice.

An interactive Jupyter notebook tutorial is another possibility, but I'm not sure how it could be hosted. I've heard of free services, but I'm not sure if they would support our kernel. Pyodide might be an alternative. It might be powerful enough to run a Hebigo compiler.

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