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

Docs, doc-tests, unit-tests #46

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

AdrienChampion
Copy link

I'm getting started on this code base and find it difficult to understand as there is no documentation or tests.

After some discussion with @lefessant I started documenting/doc-testing the code. Here is a taste of it, we would like to know if you are interested in this kind of contribution.

Note that

  • most of the comments are taken from/inspired by the TON-VM description (PDF), some modifications might be needed to fit how it's actually implemented;
  • the files I changed ran through rustfmt, as is routine;
  • I also included remarks on some choices in the implementation: they might be best discussed elsewhere.

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

Successfully merging this pull request may close these issues.

1 participant