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

Minimal documentation #2

@Zearin

Description

@Zearin

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions