You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on May 28, 2019. It is now read-only.
The source code is not heavily documented - we aim to write self-explanatory, simple code instead. If you find something hard to understand, that's a bug! Feel free to open a bug report.
The problem with “self-explanatory, simple code” instead of documentation is that not everyone can read JavaScript at the level of fluency.
Since this project is supposed to be a minimalist implementation (including being here for others to write implementations in other languages), I think the project could do with a little more documentation. At the very least, 1 or 2 sentences at the beginning of each file, describing what the file contains, and its general role in the bigger picture.
The text was updated successfully, but these errors were encountered:
From the README:
The problem with “self-explanatory, simple code” instead of documentation is that not everyone can read JavaScript at the level of fluency.
Since this project is supposed to be a minimalist implementation (including being here for others to write implementations in other languages), I think the project could do with a little more documentation. At the very least, 1 or 2 sentences at the beginning of each file, describing what the file contains, and its general role in the bigger picture.
The text was updated successfully, but these errors were encountered: