Add doc strings to public API + add attempt errors + reorganize some files #27
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
…files Go through and add docstrings to almost the entirety of the public API, including examples and other niceties. This should be quite helpful to many people because VSCode renders Python docstrings when hovering over symbols. It could also be presumably used for producing Python docs, but I'm not going to bother with that. Add an `AttemptError` data class that unmarshals itself from `errors` on an insertion, although this will likely be only nominally useful since newly inserted rows never have any errors yet. Also, shift around some types around so they're in files named appropriately for what they are (e.g. `insert_opts.py`) rather than generic names (e.g. `model.py`). This also helps match the structure of the Ruby project so that it's easier to find things.
brandur
force-pushed
the
brandur-doc-strings
branch
from
d53a15f to
cf152d2
Compare
brandur
added a commit
that referenced
this pull request
Jul 7, 2024
Follows up #27 to add a more elaborate test that checks that non-default job properties can unmarshal to `Job` property including `errors, which includes `AttemptError`. It turned out that of course this wasn't working properly.
brandur
added a commit
that referenced
this pull request
Jul 7, 2024
Follows up #27 to add a more elaborate test that checks that non-default job properties can unmarshal to `Job` property including `errors, which includes `AttemptError`. It turned out that of course this wasn't working properly.
brandur
added a commit
that referenced
this pull request
Jul 7, 2024
Follows up #27 to add a more elaborate test that checks that non-default job properties can unmarshal to `Job` property including `errors, which includes `AttemptError`. It turned out that of course this wasn't working properly.
brandur
added a commit
that referenced
this pull request
Jul 7, 2024
Follows up #27 to add a more elaborate test that checks that non-default job properties can unmarshal to `Job` property including `errors, which includes `AttemptError`. It turned out that of course this wasn't working properly.
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.
Go through and add docstrings to almost the entirety of the public API,
including examples and other niceties. This should be quite helpful to
many people because VSCode renders Python docstrings when hovering over
symbols. It could also be presumably used for producing Python docs, but
I'm not going to bother with that.
Add an
AttemptErrordata class that unmarshals itself fromerrorsonan insertion, although this will likely be only nominally useful since
newly inserted rows never have any errors yet.
Also, shift around some types around so they're in files named
appropriately for what they are (e.g.
insert_opts.py) rather thangeneric names (e.g.
model.py). This also helps match the structure ofthe Ruby project so that it's easier to find things.