Repository navigation
Sdk review updates - #18
Open
dariyaanis wants to merge 11 commits into
Open
dariyaanis wants to merge 11 commits into
dariyaanis wants to merge 11 commits into
Conversation
- reject whitespace-only client_key in both clients - document ValidationError in solve() and create_task() docstrings and README - mark every task parameter as Required or Optional in docstrings - replace em dash in proxy support table with a plain dash - update README references to renamed example files Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This branch has not been deployed
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
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.
Summary
This PR applies the SDK review updates as a series of focused commits:
py.typedmarker is required;1.0.4to1.0.5.The existing public API documentation was also reviewed. Public clients, methods, task classes, and exceptions already provide Python docstrings, type annotations, parameter descriptions, return values, raised exceptions, and usage examples.
Validation
python -m pytest -q -p no:cacheprovider- 86 passedpython -m ruff check .- passedpython -m build- sdist and wheel built successfullypython -m twine check --strict dist/*- passedRelease
After this PR is merged and the
mainworkflow passes, tag the merge commit asv1.0.5and push the tag. The existing publish workflow will verify the version, publish the package to PyPI, and create the GitHub release.