Repository navigation
docs: README accuracy and structure pass - #16
Closed
embeddinglayer wants to merge 1 commit into
Closed
embeddinglayer wants to merge 1 commit into
embeddinglayer wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Note
Copilot was unable to complete this review at the selected tier due to model policy or plan restrictions.
🟡 Changes recommended
The change still needs updates because the README’s exception documentation is inaccurate and overly broad, omitting that invalid input types can raise TypeError/AttributeError (not just ValueError), which could mislead users.
2 open issues
What changed in this PR
Updates the repository README for accuracy and consistency with the standardized SDK README structure while aligning examples and behavioral notes with the current Python SDK.
Changes:
- Reorganized and renamed sections, rebuilt the table of contents, and consolidated method listings into relevant sections.
- Added/updated examples and documented behavior for lookups, feeds/exports/downloads, async usage, retries/timeouts, configuration, response metadata, and gRPC schema.
- Added deep links from each section to the corresponding docs.synthient.com pages.
| File | Description |
|---|---|
| README.md | Restructures the README and refreshes examples and behavior documentation to match the current SDK surface area and standardized README layout. |
Review effort: Balanced
| ``` | ||
|
|
||
| `network`, `location`, and `intelligence` are `None` when the API has no data for them. A client pools connections and is safe to share across threads, so reuse one and close it with `close()` or a `with` block. The examples below reuse an open `client`, and runnable programs are in [examples](https://github.com/synthient/synthient-python/tree/main/examples). | ||
| `network`, `location`, and `intelligence` are `None` when the API has no data for them. An invalid address raises `ValueError` before any request is sent, and a private or reserved address raises an `APIError` with status 422. |
| | `user_agent` | `None` | A product token appended to the `User-Agent` header | | ||
| | `response_hook` | `None` | Called with the [metadata](#response-metadata) of every API response | | ||
|
|
||
| An invalid argument raises `ValueError` when the client is created, and an API key that is not a string raises `TypeError`. |
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.

Brings the README in line with the section order shared by the other SDK READMEs and checks it against the source. Only
README.mdchanges; existing wording is kept wherever it was already correct.Structure
Added (each checked against
src/synthient)lookup_ipacceptsipaddressobjects and rejects invalid input before a request; empty and oversized batches;lookup_domainlimitrange and default, and the "inactive" result (_base.py,_client.py).lookup_quota.resets_in, and ahealth()example.list_exportslimitrange and default.Retry-After, and no retry whenRetry-Afterexceeds a minute (_retry.py).APITimeoutError, except while reading adownload()body.synthient.__version__and theUser-Agentprefix.headers.endpoint,plaintext,symbolsandtimeoutarguments offetch()(grpcschema.py).Not verified from this repository
ja4trow of the feed table is left exactly as it was. Its scope names (JA4T_STREAM,JA4T_FEED) do not appear in.sdkgen/openapi.json, unlike every other scope in the table.