Improve the documentation of updateVoucherTypeDescription function

iExecBlockchainComputing · Jan 3, 2025 · c9ee780 · c9ee780
1 parent 06e7115
commit c9ee780
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/contracts/VoucherHub.sol b/contracts/VoucherHub.sol
@@ -107,7 +107,7 @@ contract VoucherHub is
      * This function only updates the duration for newly minted vouchers and not the existing ones to provide
      * guarantees regarding the expiration of vouchers. When a voucher is delivered, its credits should not expire
      * before the original expiration date.
-     * This is not a bug as mentioned in audit of Halborn (HAL-01) but an intended feature.
+     * As mentioned in Halborn audit report (HAL-01), this is not a bug, but rather, an intended feature.
      */
     function updateVoucherTypeDescription(
         uint256 id,

diff --git a/docs/VoucherHub.md b/docs/VoucherHub.md
@@ -60,7 +60,7 @@ function updateVoucherTypeDescription(uint256 id, string description) external
 This function only updates the duration for newly minted vouchers and not the existing ones to provide
 guarantees regarding the expiration of vouchers. When a voucher is delivered, its credits should not expire
 before the original expiration date.
-This is not a bug as mentioned in audit of Halborn (HAL-01) but an intended feature.
+As mentioned in Halborn audit report (HAL-01), this is not a bug, but rather, an intended feature.
 
 ### updateVoucherTypeDuration