Repository navigation
docs: stop telling README readers that region is mandatory - #87
Merged
Merged
Conversation
Member
Author
|
@salty-hambot review |
ClayMav
marked this pull request as ready for review
October 28, 2026 21:54
sfishel18
approved these changes
Oct 28, 2026
sfishel18
approved these changes
Oct 28, 2026
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
The README still said
regionis mandatory and that sessions without one land inaws-us-west-2. That contradicts its own "Basic usage" section, and since 0.28.0 the driver leaves an omitted region out of the request so the API applies the organization's default. It also had theStoredefaults wrong, and it calledapilevel/threadsafety/paramstylemodule-level globals whenwherobots.dbdoesn't export them.This PR:
regionoptional with the org default and removes the stale us-west-2 warning.Store:formatis required,singledefaults toFalse, andgenerate_presigned_urlrequiressingle=True.wherobots.db.driver. Docs only, no code change.Related Issues
None.
Requester Checklist
Complete these before marking Ready for Review
Visual Proof
Ran these with
uv run python -c ...on this branch:hasattr(wherobots.db, "apilevel")isFalse.from wherobots.db.driver import apilevel, threadsafety, paramstylegives2.0 1 pyformat.dataclasses.fields(Store):formathas no default,single=False,generate_presigned_url=False,options=None.Store.for_download()givesformat=PARQUET, single=True, generate_presigned_url=True.Store(format=StorageFormat.CSV, generate_presigned_url=True)raisesValueError: Presigned URL can only be generated when single=True.connect()(driver.py) setsparams={"region": region_name, ...}, andrequestsomits aNoneparam, so an omitted region is never sent.pre-commit run --files README.mdpasses (end-of-file, trailing whitespace, codespell).An independent adversarial agent review found no false claims. Its one nit, the presigned URL needing
single=True, is fixed here. It also flagged theStoredocstring inmodels.py, which still saysformatdefaults to parquet. That is left for a separate change, along with thepyproject.tomlHomepage/Tracker URLs.Size Justification (if L/XL)
N/A
Reviewer Checklist
If these are not met, close the tab — this PR is not ready for review
Changes made by Claude Opus 5.5 via Claude Code.