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 Sortition Documentation #1493

Merged
merged 13 commits into from
Feb 16, 2023
Merged

Improve Sortition Documentation #1493

merged 13 commits into from
Feb 16, 2023

Conversation

fed-franz
Copy link
Contributor

@fed-franz fed-franz commented Feb 6, 2023

This PR adds/improves documentation of Deterministic Sortition code.


Resolves #1491

@fed-franz fed-franz self-assigned this Feb 6, 2023
@fed-franz fed-franz changed the title Document Sortition Improve Sortition Documentation Feb 6, 2023
@codecov-commenter
Copy link

codecov-commenter commented Feb 7, 2023

Codecov Report

Base: 40.18% // Head: 40.14% // Decreases project coverage by -0.04% ⚠️

Coverage data is based on head (79b1346) compared to base (57c6bbd).
Patch coverage: 19.46% of modified lines in pull request are covered.

❗ Current head 79b1346 differs from pull request most recent head 3b7351c. Consider uploading reports for the commit 3b7351c to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1493      +/-   ##
==========================================
- Coverage   40.18%   40.14%   -0.04%     
==========================================
  Files         147      147              
  Lines        9651     9737      +86     
==========================================
+ Hits         3878     3909      +31     
- Misses       5144     5204      +60     
+ Partials      629      624       -5     
Impacted Files Coverage Δ
pkg/config/genesis/config.go 0.00% <ø> (ø)
pkg/config/genesis/presets.go 69.23% <ø> (ø)
...nsensus/blockgenerator/candidate/blockgenerator.go 0.00% <0.00%> (ø)
...core/consensus/blockgenerator/candidate/genesis.go 0.00% <0.00%> (ø)
...kg/core/consensus/blockgenerator/candidate/mock.go 0.00% <0.00%> (ø)
pkg/core/consensus/user/sortition.go 58.25% <ø> (ø)
pkg/core/data/ipc/transactions/fixtures.go 13.76% <0.00%> (-0.21%) ⬇️
pkg/core/data/ipc/transactions/provider.go 0.00% <0.00%> (ø)
pkg/gql/query/blocks.go 63.22% <0.00%> (ø)
pkg/gql/query/mempool.go 30.00% <0.00%> (ø)
... and 12 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@fed-franz fed-franz force-pushed the doc-sortition-1491 branch 2 times, most recently from 9b1cd3a to d838e49 Compare February 7, 2023 15:08
@fed-franz fed-franz marked this pull request as ready for review February 7, 2023 15:23
Copy link
Member

@herr-seppia herr-seppia left a comment

Choose a reason for hiding this comment

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

LGTM

just 2 suggestion to be consistent between comments format

pkg/core/consensus/user/sortition.go Outdated Show resolved Hide resolved
pkg/core/consensus/user/sortition.go Outdated Show resolved Hide resolved
pkg/core/consensus/user/sortition.go Show resolved Hide resolved
@fed-franz fed-franz merged commit c052306 into master Feb 16, 2023
@fed-franz fed-franz deleted the doc-sortition-1491 branch February 16, 2023 14:19
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.

Improve Sortition Code Documentation
3 participants