search

KingsburyLab / pyEQL

A Python library for solution chemistry
Other
65 stars 17 forks source link

Goal: Increase test coverage to 90% #62

Open rkingsbury opened 11 months ago

rkingsbury commented 11 months ago

The project's test coverage is currently about 76%. I'd like to see that increased above 90% in the near term, and 95+% eventually.

The current coverage report shows what is and is not covered. As far as adding tests, I suggest the following order of priority:

  1. Get solution.py close to 100%
  2. get solute.py close to 100%
  3. work on activity_correction.py
  4. equilibrium.py
  5. functions.py (lowest coverage, but also not part of the Solution interface and maybe not often used.

Some of this work may overlap with #57

VascoSch92 commented 4 months ago

Hey,

interested to help for this issue.

What is the current coverage and what are the portion of code which need more tests?

rkingsbury commented 4 months ago

Hi @VascoSch92 , thanks so much for your willingness to help! As stated in the first post, the current coverage report shows the specific lines that are and are not covered by tests right now. For example, the donnan_eql function in functions.py is not tested, and this results in a low coverage % for that whole file.

There are also a few methods/properties and edge cases in solution.py which don't have tests.

Let me know if you have other specific questions I can answer, or if you need any guidance before opening a PR.