search

Cyfrin / foundry-defi-stablecoin-cu

249 stars 117 forks source link

Fix comment errors in DSCEngine contract #98

Closed kelbelss closed 2 weeks ago

kelbelss commented 2 months ago

This pull request addresses several minor documentation and comment issues in the DSCEngine contract:

  1. Corrected the natspec comment for the redeemCollateralForDsc function:

    • Changed "depositing" to "withdrawing" to accurately reflect the function's purpose.

  2. Fixed a small typo in the burnDsc function comment:

    • Changed "you DSC" to "your DSC".

  3. Corrected another small typo in the mintDsc function comment:

    • Changed "hav" to "have".

These changes improve the clarity of the documentation, which will help us newer developers better understand the contract's functionality and reduce confusion.

EngrPips commented 2 months ago

Hello @kelbelss, Thanks for this contribution and this will be attended to appropriately as soon as possible.

PatrickAlphaC commented 2 weeks ago

Not sure how I missed this, ty!