Skip to content
This repository has been archived by the owner on May 28, 2019. It is now read-only.

Minimal documentation #2

Open
Zearin opened this issue Nov 6, 2015 · 1 comment
Open

Minimal documentation #2

Zearin opened this issue Nov 6, 2015 · 1 comment

Comments

@Zearin
Copy link

Zearin commented Nov 6, 2015

From the README:

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.

@aslakhellesoy
Copy link
Contributor

I see your point. I'm busy in the next 4-6 weeks so don't hold your breath.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants