Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Collection::push documentation #317

Open
a-0-dev opened this issue Apr 17, 2024 · 0 comments
Open

Improve Collection::push documentation #317

a-0-dev opened this issue Apr 17, 2024 · 0 comments

Comments

@a-0-dev
Copy link

a-0-dev commented Apr 17, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant