From 525a6728625d40c738dc7d1ec9e518e066f22054 Mon Sep 17 00:00:00 2001 From: Francisco Giordano Date: Wed, 16 Feb 2022 16:42:33 -0300 Subject: [PATCH] Add missing docs about reverts in DoubleEndedQueue --- contracts/utils/structs/DoubleEndedQueue.sol | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/contracts/utils/structs/DoubleEndedQueue.sol b/contracts/utils/structs/DoubleEndedQueue.sol index f07b312a7..5ac2766eb 100644 --- a/contracts/utils/structs/DoubleEndedQueue.sol +++ b/contracts/utils/structs/DoubleEndedQueue.sol @@ -102,6 +102,8 @@ library DoubleEndedQueue { /** * @dev Returns the item at the beginning of the queue. + * + * Reverts with `Empty` if the queue is empty. */ function front(Bytes32Deque storage deque) internal view returns (bytes32 value) { if (empty(deque)) revert Empty(); @@ -111,6 +113,8 @@ library DoubleEndedQueue { /** * @dev Returns the item at the end of the queue. + * + * Reverts with `Empty` if the queue is empty. */ function back(Bytes32Deque storage deque) internal view returns (bytes32 value) { if (empty(deque)) revert Empty();