Skip to content

Doctest required #142

Closed
Closed
@itsvinayak

Description

@itsvinayak
Member

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

Activity

cclauss

cclauss commented on May 12, 2020

@cclauss
Member

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

itsvinayak commented on May 12, 2020

@itsvinayak
MemberAuthor

@cclauss currently none of the files have Doctest

cclauss

cclauss commented on May 12, 2020

@cclauss
Member

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

itsvinayak commented on May 12, 2020

@itsvinayak
MemberAuthor

more people of the community should discuss this issue

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

nandanvasudevan commented on Aug 2, 2020

@nandanvasudevan
Contributor

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

29 remaining items

cclauss

cclauss commented on Jun 8, 2021

@cclauss
Member

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.

raklaptudirm

raklaptudirm commented on Jun 8, 2021

@raklaptudirm
Member

@cclauss We still haven't settled on the issues of doctests failing because some files have none.

Ameya101

Ameya101 commented on Jul 12, 2021

@Ameya101

Add it in Contributing.md dont create a new file

defaude

defaude commented on Oct 5, 2021

@defaude
Contributor

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

added
wontfixWill not be fixed or is a feature
and removed
featureAdds a new feature
on Oct 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

wontfixWill not be fixed or is a feature

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

    Development

    No branches or pull requests

      Participants

      @defaude@Khez@cclauss@sukhpreetsekhon@marsonya

      Issue actions

        Doctest required · Issue #142 · TheAlgorithms/JavaScript