Browse Source

Add missing docs about reverts in DoubleEndedQueue

Francisco Giordano 3 years ago
parent
commit
525a672862
1 changed files with 4 additions and 0 deletions
  1. 4 0
      contracts/utils/structs/DoubleEndedQueue.sol

+ 4 - 0
contracts/utils/structs/DoubleEndedQueue.sol

@@ -102,6 +102,8 @@ library DoubleEndedQueue {
 
 
     /**
     /**
      * @dev Returns the item at the beginning of the queue.
      * @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) {
     function front(Bytes32Deque storage deque) internal view returns (bytes32 value) {
         if (empty(deque)) revert Empty();
         if (empty(deque)) revert Empty();
@@ -111,6 +113,8 @@ library DoubleEndedQueue {
 
 
     /**
     /**
      * @dev Returns the item at the end of the queue.
      * @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) {
     function back(Bytes32Deque storage deque) internal view returns (bytes32 value) {
         if (empty(deque)) revert Empty();
         if (empty(deque)) revert Empty();