search

TidierOrg / Tidier.jl

Meta-package for data analysis in Julia, modeled after the R tidyverse.
MIT License
524 stars 14 forks source link

Convert docstring examples to jldoctests. #19

Closed kdpsingh closed 1 year ago

kdpsingh commented 1 year ago

I would like to convert all of the current documentation string examples into jldoctests. This seems to be a really efficient way to incorporate testing into the package while also making the documentation better (a win-win!).

I would love to get help with this.

Please reply to this issue if interested to work on this, and I will "assign" it to you to prevent redundant work.

zhezhaozz commented 1 year ago

I can handle this.

kdpsingh commented 1 year ago

Excellent! Once you finish, I would suggest removing the tests folder entirely so we can concentrate all the tests within the docstrings only.

rdboyes commented 1 year ago

I wouldn't remove it entirely personally - see here: https://documenter.juliadocs.org/stable/man/doctests/index.html#Doctesting-as-Part-of-Testing - the current runtests.jl file can be replaced with a call to doctests(Tidier). This would make it easy to automate the running of the doctests and also allow future unit tests that don't belong in the documentation to be added

kdpsingh commented 1 year ago

Thank you @rdboyes. Would you be willing to review the PR when it is ready for merging?

If not, all good! Just wanted to ask.

rdboyes commented 1 year ago

Sure - happy to review!

kdpsingh commented 1 year ago

Resolved by PR #25.