Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better documentation and better struct/field naming #29

Merged
merged 10 commits into from
Nov 29, 2021
Merged

Conversation

lmammino
Copy link
Member

@lmammino lmammino commented Nov 27, 2021

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
Copy link

codecov-commenter commented Nov 27, 2021

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%) ⬆️
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%) ⬆️
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 lmammino marked this pull request as ready for review November 27, 2021 19:49
@lmammino lmammino self-assigned this Nov 27, 2021
@lmammino lmammino changed the title Better documentation Better documentation and better struct/fields naming Nov 27, 2021
README.md Outdated Show resolved Hide resolved
src/cwt.rs Outdated Show resolved Hide resolved
lmammino and others added 2 commits November 28, 2021 10:38
Co-authored-by: Tommaso Allevi <tomallevi@gmail.com>
Co-authored-by: Tommaso Allevi <tomallevi@gmail.com>
@lmammino
Copy link
Member Author

Thanks @allevo! Applied your suggestions :)

@lmammino lmammino changed the title Better documentation and better struct/fields naming Better documentation and better struct/field naming Nov 28, 2021
Copy link
Collaborator

@lu-zero lu-zero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Neat documentation
  • Nicer/Simpler types

I like it a lot.

@lmammino lmammino merged commit 5d18f6d into main Nov 29, 2021
@lmammino lmammino deleted the better-docs branch November 29, 2021 13:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename all "cryptic" fields into more descriptive names Refine documentation
5 participants