Doctest required

[itsvinayak]

it will be good if algorithms have Doctest's https://www.npmjs.com/package/doctest

[cclauss]

Which files in this repo currently have doctests?
It would be good to have a list of examples in this repo that contributors could review.

[itsvinayak]

@cclauss currently none of the files have Doctest

[cclauss]

Todos:

• Add doctests to at least two algorithms in this repo BogoSort.js: Simplify Array.isSorted() and add doctests #171
• Help at least one contributor to add doctests to a new algorithm contribution
• Discuss how difficult it was to complete 1. and 2.
• Decide if we should make doctests a requirement of new contributions to this repo.

[itsvinayak]

more people of the community should discuss this issue

[nandanvasudevan]

Can we update the package.json with DocTest?
It's really easy to use especially for everything in this repo.