Skip to content
This repository has been archived by the owner on Oct 31, 2024. It is now read-only.

Update documentation #7

Merged
merged 5 commits into from
Oct 11, 2023
Merged

Update documentation #7

merged 5 commits into from
Oct 11, 2023

Conversation

Nashtare
Copy link
Member

@Nashtare Nashtare commented Oct 7, 2023

Description

Updates the documentation throughout the lib:

  • rearrange display for better reader convenience
  • fix typos
  • unify wording of serialization (british vs american)

PR Checklist:

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added or updated tests that comprehensively prove my change is effective or that my feature works

@Nashtare Nashtare requested review from 4l0n50 and LindaGuiga October 7, 2023 14:13
@Nashtare Nashtare self-assigned this Oct 7, 2023
@codecov
Copy link

codecov bot commented Oct 7, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (7553d9a) 82.68% compared to head (c9de4b2) 82.50%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main       #7      +/-   ##
==========================================
- Coverage   82.68%   82.50%   -0.19%     
==========================================
  Files          13       13              
  Lines        1057     1023      -34     
==========================================
- Hits          874      844      -30     
+ Misses        183      179       -4     
Files Coverage Δ
src/dkg/key_generation.rs 91.11% <ø> (-0.31%) ⬇️
src/error.rs 0.00% <ø> (ø)
src/lib.rs 100.00% <ø> (ø)
src/parameters.rs 100.00% <ø> (ø)
src/sign/precomputation.rs 90.14% <ø> (-0.40%) ⬇️

... and 3 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@dvdplm dvdplm left a comment

Choose a reason for hiding this comment

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

It would be fantastic to have some of the example code be actual doctests butperhaps not in this PR.

@Nashtare
Copy link
Member Author

@dvdplm we do have actual doctests already (though more may be better)

image

@Nashtare Nashtare merged commit cec9f7d into main Oct 11, 2023
9 checks passed
@Nashtare Nashtare deleted the doc branch October 11, 2023 13:15
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants