docs: add APIConnectionError to api.md#134
Merged
Merged
Conversation
The README was updated in #132 but api.md was not. Add APIConnectionError to the package layout table, exceptions table, import example, and error handling example to match the actual public API. https://claude.ai/code/session_017tT6zLgHsBWT8er2aBf4Bz
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
2 participants
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
APIConnectionErrorto package layout table, exceptions import example, exceptions table, and error handling example inapi.mdContext
APIConnectionErrorwas added as a public exception in v0.8.0 (commit 91b2c21) and the README was updated in PR #132, butapi.mdwas not updated to match. Four locations inapi.mdwere missing the new exception.Test plan
APIConnectionErrorexists inyutori/__init__.py__all__andyutori/exceptions.pyhttps://claude.ai/code/session_017tT6zLgHsBWT8er2aBf4Bz
Generated by Claude Code
Note
Low Risk
Documentation-only change with no runtime or API behavior impact.
Overview
Brings
api.mdin line with the publicAPIConnectionErrorexception (already exported fromyutorisince v0.8.0).The package layout table, exceptions import snippet, exceptions reference table, and the error-handling example now include
APIConnectionError, with a short note that it is raised when the API cannot be reached (connection refused, DNS failure, timeout).Reviewed by Cursor Bugbot for commit 06a6ca3. Bugbot is set up for automated code reviews on this repo. Configure here.