Emphasizing (non-)mutating behaviour by using bang-bang notation
To emphasize that value! etc. are sometimes mutating, sometimes non-mutating, I suggest adopting the bang-bang notation (see https://github.com/JuliaFolds2/BangBang.jl) and renaming these functions to value!! etc.
I also added explicit warnings to each docstring.
Closes https://github.com/JuliaDiff/DiffResults.jl/issues/17. Closes https://github.com/JuliaDiff/DiffResults.jl/issues/4.
Codecov Report
:x: Patch coverage is 84.00000% with 4 lines in your changes missing coverage. Please review.
:white_check_mark: Project coverage is 86.84%. Comparing base (0479a8a) to head (1a9c174).
| Files with missing lines | Patch % | Lines |
|---|---|---|
| src/DiffResults.jl | 84.00% | 4 Missing :warning: |
Additional details and impacted files
@@ Coverage Diff @@
## master #39 +/- ##
=======================================
Coverage 86.84% 86.84%
=======================================
Files 1 1
Lines 76 76
=======================================
Hits 66 66
Misses 10 10
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
:rocket: New features to boost your workflow:
- :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.