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.

Sign up for GitHub

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

Jump to bottom

Improve Sortition Code Documentation #1491

Closed
Tracked by #1497
, #5
...
fed-franz opened this issue Feb 6, 2023 · 1 comment · Fixed by #1493
Closed
Tracked by #1497
, #5
...

Improve Sortition Code Documentation #1491

fed-franz opened this issue Feb 6, 2023 · 1 comment · Fixed by #1493
Assignees
@fed-franz
Labels
documentation Improvements or additions to documentation mark:testnet type:docs deliverable should be documentation

Comments

@fed-franz
Copy link
Contributor

fed-franz commented Feb 6, 2023 •
edited
Loading

Description

Documentation of the Deterministic Sortition code should be improved.

Files involved:

  • pkg/core/consensus/user/sortition.go

Branch: doc-sortition-1491
PR: #1493

This is part of #1490
@fed-franz fed-franz mentioned this issue Feb 6, 2023
Open
4 tasks
@fed-franz fed-franz self-assigned this Feb 6, 2023
@fed-franz fed-franz added type:docs deliverable should be documentation documentation Improvements or additions to documentation labels Feb 6, 2023
@fed-franz fed-franz mentioned this issue Feb 6, 2023
Merged
@fed-franz fed-franz changed the title Add/Improve Sortition Documentation Improve Sortition Documentation Feb 6, 2023
@fed-franz fed-franz mentioned this issue Feb 6, 2023
Closed
1 task
@fed-franz
Copy link
Contributor Author

QUESTIONS on extractCommitteeMember

line 165 handles the case in which a Member is missing.
Q: When does/can this occur?

line 167 handles a missing Member by setting the current member 'm' to Member 0.
Q: What's the logic behind this?

line 177 seems similar to line 167.
Q: What's the difference between the two cases?

fed-franz added a commit that referenced this issue Feb 16, 2023
@fed-franz
Merge pull request #1493 from dusk-network/doc-sortition-1491
c052306 
Improve Sortition Documentation

Resolves #1491
@fed-franz fed-franz mentioned this issue Feb 16, 2023
Open
4 tasks
This was referenced Mar 9, 2023
Closed
Closed
@fed-franz fed-franz changed the title Improve Sortition Documentation Improve Sortition Code Documentation Mar 16, 2023
@fed-franz fed-franz mentioned this issue Mar 21, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@fed-franz fed-franz

Labels
documentation Improvements or additions to documentation mark:testnet type:docs deliverable should be documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve Sortition Documentation dusk-network/dusk-blockchain
1 participant
@fed-franz