Thermodynamics.jl icon indicating copy to clipboard operation
Thermodynamics.jl copied to clipboard

Add example to readme docs

Open charleskawczynski opened this issue 2 years ago • 2 comments

This PR updates the readme, and provides an example.

Closes #189.

charleskawczynski avatar Nov 02 '22 21:11 charleskawczynski

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 90.40%. Comparing base (ffbbe72) to head (98a80ed). Report is 5 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #142      +/-   ##
==========================================
- Coverage   90.93%   90.40%   -0.53%     
==========================================
  Files          10        9       -1     
  Lines        1180     1167      -13     
==========================================
- Hits         1073     1055      -18     
- Misses        107      112       +5     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Nov 02 '22 21:11 codecov[bot]

It might be nice for clarity to show what the parameters are in this example, or at least give an example of inspecting the struct to find the parameters (since they cannot be determined by reading the code). We should also show users how to change the parameters.

glwagner avatar Feb 14 '24 20:02 glwagner

Thoughts on merging this and iterating? I think that this is an improvement.

charleskawczynski avatar Sep 06 '24 18:09 charleskawczynski