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

FIx: stakingReward documentation/naming issues #63

Open
dkent600 opened this issue Apr 8, 2021 · 0 comments
Open

FIx: stakingReward documentation/naming issues #63

dkent600 opened this issue Apr 8, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@dkent600
Copy link

dkent600 commented Apr 8, 2021

  1. Here:

* @param _duration Duration of the staking in days

The explanation for duration is incorrect. We added isActive for a reason, which is that duration does not suffice to compute the "duration for staking". Can we please provide a correct explanation for how duration is used?

  1. Here:

* @param _avatar Address of reward distribution recepient

Must the _avatar be an avatar? If not, can we rename this? See the following 3):

  1. Here:

rewardDistribution = _avatar;

The entire rewardDistribution nomenclature seems to make no sense. First, it is not a distribution, it is an account. Second, its use has nothing to do with who gets rewarded nor how rewards are distributed. It is only used to identify an account that can invoke a couple of functions. Wouldn't it make more sense to call this something like controller or admin?

  1. Having said 3), it is super unclear what notifyRewardAmount does. It is external, presumably meant to be invoked by rewardDistribution. Can we document this function?
@arseneeth arseneeth changed the title stakingReward documentation/naming issues FIx: stakingReward documentation/naming issues Apr 9, 2021
@arseneeth arseneeth added the documentation Improvements or additions to documentation label May 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants