diff --git a/contracts/utils/structs/Checkpoints.sol b/contracts/utils/structs/Checkpoints.sol index 5ba6ad92d..09477ee8e 100644 --- a/contracts/utils/structs/Checkpoints.sol +++ b/contracts/utils/structs/Checkpoints.sol @@ -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 * `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 - * `high` if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and - * exclusive `high`. + * @dev Return the index of the first (oldest) checkpoint with key greater or equal 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 + * `high`. * * 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 * `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 - * `high` if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and - * exclusive `high`. + * @dev Return the index of the first (oldest) checkpoint with key greater or equal 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 + * `high`. * * 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 * `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 - * `high` if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and - * exclusive `high`. + * @dev Return the index of the first (oldest) checkpoint with key greater or equal 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 + * `high`. * * WARNING: `high` should not be greater than the array's length. */ diff --git a/scripts/generate/templates/Checkpoints.js b/scripts/generate/templates/Checkpoints.js index 2291bab57..d4e70ee02 100644 --- a/scripts/generate/templates/Checkpoints.js +++ b/scripts/generate/templates/Checkpoints.js @@ -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 * \`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 - * \`high\` if there is none. \`low\` and \`high\` define a section where to do the search, with inclusive \`low\` and - * exclusive \`high\`. + * @dev Return the index of the first (oldest) checkpoint with key greater or equal 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 + * \`high\`. * * WARNING: \`high\` should not be greater than the array's length. */