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

OpynPerpVault.onlyLocked() documentation update #1

Open
andreiashu opened this issue Jul 27, 2021 · 0 comments
Open

OpynPerpVault.onlyLocked() documentation update #1

andreiashu opened this issue Jul 27, 2021 · 0 comments
Labels
Minor Report

Comments

@andreiashu
Copy link
Member

Description

The LockState modifier updates the state contract variable to VaultState.Locked:

https://github.com/monoceros-alpha/review-opyn-perp-vault-templates-2021-07/blob/d94fcb2e2173008272604705a9fc618710349462/code/contracts/core/OpynPerpVault.sol#L116-L120

The issue is that the documentation above is confusing.

Recommendation

Reword the documentation text to read (should instead of can):

should only be executed in the unlocked state
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Minor Report
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@andreiashu