Doctest required #142

Activity

1. itsvinayak

   added

   featureAdds a new featureAdds a new feature

   help wantedNeeds to be worked onNeeds to be worked on

   on May 4, 2020
2. itsvinayak

   assigned

   itsvinayak

   ,

   r0hit-gupta

   ,

   christianbender

   and

   the-codingninja

   on May 5, 2020
3. cclauss commented on May 12, 2020

   

   cclauss

   on May 12, 2020

   Last edited by cclauss

   Member

   More actions

   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.
4. itsvinayak commented on May 12, 2020

   

   itsvinayak

   on May 12, 2020

   MemberAuthor

   More actions

   @cclauss currently none of the files have Doctest
5. cclauss commented on May 12, 2020

   

   cclauss

   on May 12, 2020

   Last edited by cclauss

   Member

   More actions

   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.
6. itsvinayak commented on May 12, 2020

   

   itsvinayak

   on May 12, 2020

   MemberAuthor

   More actions

   more people of the community should discuss this issue

   👍React with 👍1Reacted by Christian Clauss
7. cclauss

   added a commit that references this issue on May 12, 2020

   BogoSort.js: Simplify Array.isSorted() and add doctests

   ...

   02585f5
8. BurhanH

   added a commit that references this issue on May 18, 2020

   Fetching last changes (#1)

   ...

   ccd8e8b
9. nandanvasudevan commented on Aug 2, 2020

   

   nandanvasudevan

   on Aug 2, 2020

   Contributor

   More actions

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

    added a commit that references this issue on Aug 2, 2020

    Add doctest to devDependencies of package.json

    ...

    4cbdc9e
11. cclauss commented on Aug 2, 2020

    

    cclauss

    on Aug 2, 2020

    Last edited by cclauss

    Member

    More actions

    update the package.json with DocTest?

    Done in 4cbdc9e

    👍React with 👍1Reacted by Nandan V
12. 17 remaining items

    Load more

13. mhihasan commented on Jun 7, 2021

    

    mhihasan

    on Jun 7, 2021

    Last edited by mhihasan

    Contributor

    More actions

    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
14. cclauss commented on Jun 8, 2021

    

    cclauss

    on Jun 8, 2021

    Last edited by cclauss

    Member

    More actions

    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.
15. raklaptudirm commented on Jun 8, 2021

    

    raklaptudirm

    on Jun 8, 2021

    Member

    More actions

    @cclauss We still haven't settled on the issues of doctests failing because some files have none.
16. Ameya101 commented on Jul 12, 2021

    

    Ameya101

    on Jul 12, 2021

    More actions

    Add it in Contributing.md dont create a new file
17. defaude commented on Oct 5, 2021

    

    defaude

    on Oct 5, 2021

    Contributor

    More actions

    @raklaptudirm I recommend we close this issue in favour of #742
18. raklaptudirm

    closed this as completedon Oct 5, 2021
19. raklaptudirm

    added

    wontfixWill not be fixed or is a featureWill not be fixed or is a feature

    and removed

    featureAdds a new featureAdds a new feature

    help wantedNeeds to be worked onNeeds to be worked on

    on Oct 5, 2021
20. stardev97

    added a commit that references this issue on Apr 1, 2022

    Add doctest to devDependencies of package.json

    ...

    1bd00de
21. mariannepara

    added a commit that references this issue on Apr 20, 2022

    Add doctest to devDependencies of package.json

    ...

    3beb7fb
22. ferranm99

    added a commit that references this issue on May 20, 2022

    Add doctest to devDependencies of package.json

    ...

    4416b6b
23. patrickm68

    added a commit that references this issue on Dec 1, 2022

    Add doctest to devDependencies of package.json

    ...

    9997532
24. vectorcrown

    added a commit that references this issue on Aug 3, 2023

    Add doctest to devDependencies of package.json

    ...

    4508476
25. goncalo0604dev-creator

    added a commit that references this issue on Mar 17, 2026

    Add doctest to devDependencies of package.json

    ...

    671c1af