3 Matching Annotations
  1. Jun 2022
    1. Expectation Reference

      Very thorough documentation. I would like to suggest adding a contribution guideline (or point to the CONTRIBUTING.md in the repo), how to get support, how to cite (after you release on arxiv or on joss) and possibly a design overview, which users ask about often and gives the library more credibility. The first 3 items can just be added to the readme.

    1. To start, set up a Jupyter notebook, install pandas and datapact, load up the Iris Dataset, and create a new datapact test object:

      Here also would be better to have code blocks so the user can copy/paste. A link for an interactive notebook at the beginning and end would again be valuable.

    1. Perhaps it would be better to add a link to a google colabs notebook, which shows the library in action and is interactive. Adding images is frowned upon on the technical writing community since it can become difficult to keep up to date. Code is better because you can have unit tests to make sure your examples are always working or you can at least pinpoint the version of your library and its dependencies in your interactive notebook.