Skip to content
This repository was archived by the owner on Aug 2, 2022. It is now read-only.

[docs] Incorrect info for multi-index upper_bound #904

Closed
Avm07 opened this issue Jun 9, 2020 · 0 comments
Closed

[docs] Incorrect info for multi-index upper_bound #904

Avm07 opened this issue Jun 9, 2020 · 0 comments
Assignees
Labels
documentation Documentation related edits, non-breaking only

Comments

@Avm07
Copy link

Avm07 commented Jun 9, 2020

function upper_bound
const_iterator eosio::multi_index< TableName, T, Indices >::upper_bound(
    uint64_t primary
) const

Searches for the object_type with the lowest primary key that is greater than a given primary key.

Returns:
An iterator pointing to the object_type that has the highest primary key that is less than or equal to primary. If an object could not be found, it will return the end iterator. If the table does not exist** it will return -1.

Guess this is typo mistake and its return less than or equal

The -1 is wrong, iterators can't be -1 and it will return .end().

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Documentation related edits, non-breaking only
Projects
None yet
Development

No branches or pull requests

3 participants