bonsaidb icon indicating copy to clipboard operation
bonsaidb copied to clipboard

Improve `Collection::push` documentation

Open a-0-dev opened this issue 2 years ago • 0 comments

As Transaction::insert(...)'s documentation comment states, the function returns a ConflictError if the ID of the document already exists.

Since this function is buried deep down in BonsaiDB's code, I would suggest adding a hint to that behaviour in the docstring of Collection::push(...), since that is the function users will most likely interact with.

a-0-dev avatar Apr 17 '24 16:04 a-0-dev