NoBey/openzeppelin-contracts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix documentation of private function _upperLookupBinary in Checkpoints.sol (#5128)

Browse Source 
Co-authored-by: cairo <cairoeth@protonmail.com>
This commit is contained in:
Hadrien Croubois
2024-07-29 18:58:02 +02:00
committed by GitHub
parent 659f3063f8
commit 9d6a0cc7e9
2 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
contracts/utils/structs/Checkpoints.sol
View File

@ -154,7 +154,7 @@ library Checkpoints {
} }
/** /**
* @dev Return the index of the last (most recent) checkpoint with key lower or equal than the search key, or `high` * @dev Return the index of the first (oldest) checkpoint with key strictly bigger than the search key, or `high`
* if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and exclusive * if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and exclusive
* `high`. * `high`.
* *
@ -178,9 +178,9 @@ library Checkpoints {
} }
/** /**
* @dev Return the index of the first (oldest) checkpoint with key is greater or equal than the search key, or * @dev Return the index of the first (oldest) checkpoint with key greater or equal than the search key, or `high`
* `high` if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and * if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and exclusive
* exclusive `high`. * `high`.
* *
* WARNING: `high` should not be greater than the array's length. * WARNING: `high` should not be greater than the array's length.
*/ */
@ -349,7 +349,7 @@ library Checkpoints {
} }
/** /**
* @dev Return the index of the last (most recent) checkpoint with key lower or equal than the search key, or `high` * @dev Return the index of the first (oldest) checkpoint with key strictly bigger than the search key, or `high`
* if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and exclusive * if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and exclusive
* `high`. * `high`.
* *
@ -373,9 +373,9 @@ library Checkpoints {
} }
/** /**
* @dev Return the index of the first (oldest) checkpoint with key is greater or equal than the search key, or * @dev Return the index of the first (oldest) checkpoint with key greater or equal than the search key, or `high`
* `high` if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and * if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and exclusive
* exclusive `high`. * `high`.
* *
* WARNING: `high` should not be greater than the array's length. * WARNING: `high` should not be greater than the array's length.
*/ */
@ -544,7 +544,7 @@ library Checkpoints {
} }
/** /**
* @dev Return the index of the last (most recent) checkpoint with key lower or equal than the search key, or `high` * @dev Return the index of the first (oldest) checkpoint with key strictly bigger than the search key, or `high`
* if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and exclusive * if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and exclusive
* `high`. * `high`.
* *
@ -568,9 +568,9 @@ library Checkpoints {
} }
/** /**
* @dev Return the index of the first (oldest) checkpoint with key is greater or equal than the search key, or * @dev Return the index of the first (oldest) checkpoint with key greater or equal than the search key, or `high`
* `high` if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and * if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and exclusive
* exclusive `high`. * `high`.
* *
* WARNING: `high` should not be greater than the array's length. * WARNING: `high` should not be greater than the array's length.
*/ */

8
scripts/generate/templates/Checkpoints.js
View File

@ -159,7 +159,7 @@ function _insert(${opts.checkpointTypeName}[] storage self, ${opts.keyTypeName}
} }
/** /**
* @dev Return the index of the last (most recent) checkpoint with key lower or equal than the search key, or \`high\` * @dev Return the index of the first (oldest) checkpoint with key strictly bigger than the search key, or \`high\`
* if there is none. \`low\` and \`high\` define a section where to do the search, with inclusive \`low\` and exclusive * if there is none. \`low\` and \`high\` define a section where to do the search, with inclusive \`low\` and exclusive
* \`high\`. * \`high\`.
* *
@ -183,9 +183,9 @@ function _upperBinaryLookup(
} }
/** /**
* @dev Return the index of the first (oldest) checkpoint with key is greater or equal than the search key, or * @dev Return the index of the first (oldest) checkpoint with key greater or equal than the search key, or \`high\`
* \`high\` if there is none. \`low\` and \`high\` define a section where to do the search, with inclusive \`low\` and * if there is none. \`low\` and \`high\` define a section where to do the search, with inclusive \`low\` and exclusive
* exclusive \`high\`. * \`high\`.
* *
* WARNING: \`high\` should not be greater than the array's length. * WARNING: \`high\` should not be greater than the array's length.
*/ */