joseph-roitman / pytest-snapshot

A plugin for snapshot testing with pytest.
MIT License
117 stars 12 forks source link

Improve error messages for users unfamiliar with the library. #56

Closed joseph-roitman closed 2 years ago

joseph-roitman commented 2 years ago

Developers entering a codebase that uses pytest-snapshot might not know what to do if they break a snapshot test. This commit improves error messages by adding suggested next steps to resolve the issue.

This PR fixes #53.

codecov[bot] commented 2 years ago

Codecov Report

Merging #56 (f69e16f) into master (4230cc6) will decrease coverage by 0.00%. The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master      #56      +/-   ##
==========================================
- Coverage   99.58%   99.58%   -0.01%     
==========================================
  Files           8        8              
  Lines         485      484       -1     
  Branches       58       58              
==========================================
- Hits          483      482       -1     
  Misses          2        2              
Impacted Files Coverage Δ
tests/test_assert_match.py 100.00% <ø> (ø)
tests/test_assert_match_dir.py 100.00% <ø> (ø)
tests/test_misc.py 100.00% <ø> (ø)
pytest_snapshot/plugin.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 4230cc6...f69e16f. Read the comment docs.