Misc improvements to the `@resumable` macro

JuliaDynamics / ResumableFunctions.jl

C# style generators a.k.a. semi-coroutines for Julia.

Other

160 stars 19 forks source link

Misc improvements to the `@resumable` macro #71

Closed Krastanov closed 1 year ago

Krastanov commented 1 year ago

more descriptive names generated symbols
enable docstrings for @resumable functions
do not delete line number nodes in @resumable functions

Fixes #39

Fixes #45

Initial steps needed to address #46

codecov-commenter commented 1 year ago

Codecov Report

Merging #71 (84c2c51) into master (727ba4a) will decrease coverage by 6.27%. The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master      #71      +/-   ##
==========================================
- Coverage   93.49%   87.22%   -6.27%     
==========================================
  Files           5        5              
  Lines         292      321      +29     
==========================================
+ Hits          273      280       +7     
- Misses         19       41      +22

Files Changed	Coverage Δ
src/macro.jl	`87.23% <100.00%> (ø)`
src/transforms.jl	`79.72% <100.00%> (-14.14%)`	:arrow_down:

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

Krastanov commented 1 year ago

The coverage calculations seem to be wrong... But the previous coverage calculations were probably wrong too. The changes happened because of the various modifications I have made in order to preserve Line Number Nodes, which are necessary for correct coverage tracking. Further improvements are necessary for this to properly track coverage, but this should be better than the status quo.

Krastanov commented 1 year ago

One can verify that the coverage reporting is nonsense here: https://app.codecov.io/gh/JuliaDynamics/ResumableFunctions.jl/pull/71/blob/src/transforms.jl -- e.g. documentation strings and lines containing only end are marked as not covered...