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

Variable Naming #221

Closed
BrendanChou opened this issue Apr 6, 2019 · 0 comments

Comments

@BrendanChou
Copy link
Contributor

commented Apr 6, 2019

To favor explicitness and readability, several parts of the contracts may benefit from better naming. Our suggestions are:
Will Fix:

  • ttype to type in Actions.sol, line 152 and Actions.sol, line 172.
  • x to number in Math.sol, lines 69, 85 and 100.
  • r to result in Math.sol, lines 75, 91 and 107.
  • arg to action.
    • Changed in some places

Will not fix:

  • In Admin.sol and AdminImpl.sol, drop the word “owner” from the function names. For example, ownerWithdrawExcessTokens to withdrawExcessTokens.
    • Will not fix
  • OperatorArg to Operator.
    • Will not fix, operator is a part of an OperatorArg
  • operator to account.
    • Will not fix, we consider "account" to be a different term
  • getAccountValues to getAccountSupplyAndBorrowValues in Storage.sol, line 296 and Getters.sol, line 319.
    • Will not fix
  • getAdjustedAccountValues to getAccountSupplyAndBorrowValuesAdjusted.
    • Will not fix
  • getIsLocalOperator to isLocalOperator.
    • Will not fix
  • getIsGlobalOperator to isGlobalOperator.
    • Will not fix
  • g_state to globalState.
    • Will not fix
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant
You can’t perform that action at this time.