From c9ee780ec969ab2de70618ad0ea6021b97bc2062 Mon Sep 17 00:00:00 2001 From: Le-Caignec Date: Fri, 3 Jan 2025 17:16:53 +0100 Subject: [PATCH] Improve the documentation of updateVoucherTypeDescription function --- contracts/VoucherHub.sol | 2 +- docs/VoucherHub.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/contracts/VoucherHub.sol b/contracts/VoucherHub.sol index 1b8a88a4..58a747e0 100644 --- 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 index d17fc70a..7243624b 100644 --- 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