DEVEXP-496 Can now write a batch of documents #8
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I'm going to do docs in a separate PR, after all the metadata stuff is supported too. There are only a lot of new files here because I needed them in the test app to test out things like optimistic locking and temporal writes.
rjrudin
force-pushed
the
feature/496-write-docs
branch
from
a3f4e66 to
bbcf2b9
Compare
BillFarber
approved these changes
Jul 13, 2023
rjrudin
commented
Jul 13, 2023
| self, | ||
| uri: str, | ||
| content, | ||
| content_type: str = None, |
Contributor
Author
There was a problem hiding this comment.
One thought on this design - we should be able to reuse this class for reading documents - i.e. getting back an array of Document objects. But the args starting with content_type are all specific to writing a set of documents, and they won't be populated when reading a document. We could capture that in the docstring for the constructor, but I think they're still potentially confusing in that they're only for writing a document.
An alternative would be to use **kwargs and clearly document what keyword args can be passed in based on what you plan to do with a Document. That might be worth changing to after doing the "Read documents" story.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm going to do docs in a separate PR, after all the metadata stuff is supported too.
There are only a lot of new files here because I needed them in the test app to test out things like optimistic locking and temporal writes.