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

Improve DKG engine package documentation #6758

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

jordanschalm
Copy link
Member

  • Place documentation comments directly above package declaration, so it is interpreted by godoc as package documentation (not just a comment)
  • Align diagram components regardless of tab size
  • Add links and headers
  • Minor improvements to text

- put the godoc directly above package declaration so it appears as
  godoc
- remove tabs to correctly align diagram
@codecov-commenter
Copy link

codecov-commenter commented Nov 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 41.23%. Comparing base (b3d0864) to head (12d1320).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #6758      +/-   ##
==========================================
- Coverage   41.24%   41.23%   -0.02%     
==========================================
  Files        2061     2061              
  Lines      182687   182687              
==========================================
- Hits        75358    75338      -20     
- Misses     101019   101038      +19     
- Partials     6310     6311       +1     
Flag Coverage Δ
unittests 41.23% <ø> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

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


🚨 Try these New Features:

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.

2 participants