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

[R4R] Slight cleanup of distribution specification #2765

Merged
merged 7 commits into from
Nov 14, 2018

Conversation

alexanderbez
Copy link
Contributor

@alexanderbez alexanderbez commented Nov 11, 2018

Was re-reading through the spec and found some sentences that were worded...weirdly, so this PR simply includes some minor Markdown fixes and a few bits of rephrasing.


  • Targeted PR against correct branch (see CONTRIBUTING.md)

  • Linked to github-issue with discussion and accepted design OR link to spec that describes this work.

  • Wrote tests

  • Updated relevant documentation (docs/)

  • Added entries in PENDING.md with issue #

  • rereviewed Files changed in the github PR explorer


For Admin Use:

  • Added appropriate labels to PR (ex. wip, ready-for-review, docs)
  • Reviewers Assigned
  • Squashed all commits, uses message "Merge pull request #XYZ: [title]" (coding standards)

@alexanderbez alexanderbez added T:Docs Changes and features related to documentation. spec C:x/staking ready-for-review labels Nov 11, 2018
@alexanderbez alexanderbez changed the title Slight cleanup of distribution specification [R4R] Slight cleanup of distribution specification Nov 11, 2018
exclusive. If there are Atom commissions and auto-bonding Atoms, the portion
of Atoms the reward distribution calculation would become very large as the Atom
of Atoms in the reward distribution calculation would become very large as the Atom
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Also, I find the following to be a mouthful and somewhat hard to grasp:

If there are Atom commissions and auto-bonding Atoms, the portion
of Atoms in the reward distribution calculation would become very large as the Atom
portion for each delegator would change each block making a withdrawal of rewards
for a delegator require a calculation for every single block since the last
withdrawal.

Maybe it's just me? 😅

Copy link
Contributor

Choose a reason for hiding this comment

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

No, it could be better phrased, maybe: If there are both commissions and auto-bonding on the staking token, the amount of staking tokens each validator and delegator has would change each block, so we would have to iterate through all of them

cc @rigelrozanski

@codecov
Copy link

codecov bot commented Nov 11, 2018

Codecov Report

Merging #2765 into develop will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop    #2765   +/-   ##
========================================
  Coverage    56.68%   56.68%           
========================================
  Files          156      156           
  Lines         9788     9788           
========================================
  Hits          5548     5548           
  Misses        3862     3862           
  Partials       378      378

Copy link
Contributor

@cwgoes cwgoes left a comment

Choose a reason for hiding this comment

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

Thanks for the updates, a few more suggestions.

docs/spec/distribution/overview.md Outdated Show resolved Hide resolved
docs/spec/distribution/overview.md Outdated Show resolved Hide resolved
docs/spec/distribution/overview.md Outdated Show resolved Hide resolved
exclusive. If there are Atom commissions and auto-bonding Atoms, the portion
of Atoms the reward distribution calculation would become very large as the Atom
of Atoms in the reward distribution calculation would become very large as the Atom
Copy link
Contributor

Choose a reason for hiding this comment

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

No, it could be better phrased, maybe: If there are both commissions and auto-bonding on the staking token, the amount of staking tokens each validator and delegator has would change each block, so we would have to iterate through all of them

cc @rigelrozanski

docs/spec/distribution/overview.md Outdated Show resolved Hide resolved
@alexanderbez
Copy link
Contributor Author

Updated @cwgoes -- thanks for the feedback.

Copy link
Contributor

@cwgoes cwgoes left a comment

Choose a reason for hiding this comment

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

ACK from me. @rigelrozanski should review this too.

@rigelrozanski
Copy link
Contributor

reviewing this morning

Copy link
Contributor

@rigelrozanski rigelrozanski left a comment

Choose a reason for hiding this comment

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

just blocking merge until I review

Copy link
Contributor

@rigelrozanski rigelrozanski left a comment

Choose a reason for hiding this comment

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

check em' changes oot

docs/spec/distribution/overview.md Outdated Show resolved Hide resolved
docs/spec/distribution/overview.md Outdated Show resolved Hide resolved
docs/spec/distribution/overview.md Outdated Show resolved Hide resolved
docs/spec/distribution/overview.md Outdated Show resolved Hide resolved
rigelrozanski and others added 4 commits November 14, 2018 11:58
Co-Authored-By: alexanderbez <alexanderbez@users.noreply.github.com>
Co-Authored-By: alexanderbez <alexanderbez@users.noreply.github.com>
Co-Authored-By: alexanderbez <alexanderbez@users.noreply.github.com>
@alexanderbez
Copy link
Contributor Author

@rigelrozanski Updated!

@rigelrozanski rigelrozanski merged commit 6feab55 into develop Nov 14, 2018
@rigelrozanski rigelrozanski deleted the bez/dist-spec-cleanup branch November 14, 2018 18:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:x/staking spec T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants