squeeth-monorepo icon indicating copy to clipboard operation
squeeth-monorepo copied to clipboard

natspec and naming in ControllerHelperDataType (doesn't break anything)

Open alpinechicken opened this issue 2 years ago • 1 comments

Task:

Description

  • Added missing natspec
  • Changed MintNewLp -> MintAndLp for consistency
  • withdrawFromVault -> WithdrawFromVault
  • generalSwap -> GeneralSwap

Fixes # (issue)

Type of change

  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • [ x] Document update

How Has This Been Tested

Please describe how to test to verify the changes. Provide instructions so we can reproduce.

FE Checklist

  • [x ] I have performed a self-review of my own code
  • [ x] I have commented my code, particularly in hard-to-understand areas
  • [x ] My changes generate no new warnings
  • [ ] Added video recordings if it is a UI change

User Facing Checklist

  • [x ] I fully understand the user problem this PR is solving
  • [ x] I know who the target user is for this PR and have a deep understanding of that user
  • [x ] I have tried this flow thinking from the pov of the target user for this PR
  • [ ] I (or working w someone on team) have scheduled a user test for this PR (if it is a large change)

alpinechicken avatar Jun 15 '22 19:06 alpinechicken

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
continuouscall ✅ Ready (Inspect) Visit Preview Jun 15, 2022 at 9:04PM (UTC)

vercel[bot] avatar Jun 15 '22 19:06 vercel[bot]