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

Outdated Docstring #204

Open
asardon opened this issue Dec 30, 2023 · 0 comments
Open

Outdated Docstring #204

asardon opened this issue Dec 30, 2023 · 0 comments

Comments

@asardon
Copy link

asardon commented Dec 30, 2023

* @dev Sets the sender as the initial owner, the beneficiary as the pending owner, the start timestamp and the
* vesting duration of the vesting wallet.
*/
function __VestingWallet_init(address beneficiary, uint64 startTimestamp, uint64 durationSeconds) internal onlyInitializing {
__Ownable_init_unchained(beneficiary);
__VestingWallet_init_unchained(beneficiary, startTimestamp, durationSeconds);
}

Docstring states that there is an owner and a pending owner although no pending owner is present. Moreover, the sender isn't necessarily set as owner/beneficiary.

More accurate docstring would be:

// @dev Sets beneficiary as the owner, the start timestamp and the vesting duration of the vesting wallet. 

Similarly, in ender as the initial owner, the beneficiary as the pending owner the docstring seems outdated.

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

No branches or pull requests

1 participant