search

rust-italia / dgc

A parser and validator for the EU Digital Green Certificate (dgc) a.k.a. greenpass
https://github.com/rust-italia/dgc
MIT License
26 stars 11 forks source link

Better documentation and better struct/field naming #29

Closed lmammino closed 2 years ago

lmammino commented 2 years ago

This PR introduces a comprehensive programmatic documentation (rustdoc) and renames all the struct fields to be more descriptive (BREAKING CHANGE).

Closes #28 Closes #6

Screenshots

Screenshot 2021-11-27 at 19 47 04 Screenshot 2021-11-27 at 19 47 16 Screenshot 2021-11-27 at 19 47 36 Screenshot 2021-11-27 at 19 47 49 Screenshot 2021-11-27 at 19 48 01
codecov-commenter commented 2 years ago

Codecov Report

Merging #29 (11db80d) into main (a8255c4) will increase coverage by 3.25%. The diff coverage is 92.65%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #29      +/-   ##
==========================================
+ Coverage   82.16%   85.42%   +3.25%     
==========================================
  Files          10       10              
  Lines        1060     1077      +17     
==========================================
+ Hits          871      920      +49     
+ Misses        189      157      -32
Impacted Files Coverage Δ
src/trustlist.rs 58.87% <ø> (ø)
src/valuesets.rs 100.00% <ø> (+8.65%) :arrow_up:
src/cwt.rs 79.41% <33.33%> (ø)
src/vaccination.rs 57.89% <66.66%> (ø)
src/parse.rs 71.65% <75.00%> (ø)
src/recovery.rs 61.53% <77.77%> (+4.39%) :arrow_up:
src/dgc.rs 97.52% <97.52%> (ø)
src/dgc_container.rs 78.00% <100.00%> (ø)
src/lib.rs 86.91% <100.00%> (ø)
src/test.rs 95.45% <100.00%> (ø)
... and 5 more

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 a8255c4...11db80d. Read the comment docs.

lmammino commented 2 years ago

Thanks @allevo! Applied your suggestions :)