Repository navigation
Doctest required #142
Description
Activity
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.@cclauss currently none of the files have Doctest
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.
more people of the community should discuss this issue
Reacted by Christian Clauss- added a commit that references this issue
on May 12, 2020 Can we update the
package.jsonwith DocTest?
It's really easy to use especially for everything in this repo.- added a commit that references this issue
on Aug 2, 2020 17 remaining items
Some files have jest tests. Should we remove those jest tests and add doctest instead? Because, current doctest version is throwing error on export statement, though next release might fix this
Please do not remove tests. Contributors should have the freedom to choose to test with doctest or jest. Contibutors should not have the freedom to have no tests at all.
@cclauss We still haven't settled on the issues of doctests failing because some files have none.
Add it in Contributing.md dont create a new file
@raklaptudirm I recommend we close this issue in favour of #742
- added a commit that references this issue
on Apr 1, 2022 - added a commit that references this issue
on Apr 20, 2022 - added a commit that references this issue
on May 20, 2022 - added a commit that references this issue
on Dec 1, 2022 - added a commit that references this issue
on Aug 3, 2023 - added a commit that references this issue
on Mar 17, 2026
it will be good if algorithms have Doctest's https://www.npmjs.com/package/doctest