DOC-5880 DOC-5881 DOC-5882 DOC-5883 DOC-5885 DOC-5886 Error checking pages #2349
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
dwdougherty
approved these changes
Nov 5, 2025
| ### Pattern 1: Fail fast | ||
|
|
||
| Catch specific exceptions that represent unrecoverable errors and re-throw them (see | ||
| [Pattern 1: Fail fast]({{< relref "/develop/clients/error-handling#pattern-1-fail-fast" >}}) |
There was a problem hiding this comment.
I'm not sure why, but this anchor goes to a location well above the actually section.
| ### Pattern 2: Graceful degradation | ||
|
|
||
| Catch specific errors and fall back to an alternative, where possible (see | ||
| [Pattern 2: Graceful degradation]({{< relref "/develop/clients/error-handling#pattern-2-graceful-degradation" >}}) |
There was a problem hiding this comment.
This one too. Maybe the diagrams are throwing something off?
| ### Pattern 3: Retry with backoff | ||
|
|
||
| Retry on temporary errors such as timeouts (see | ||
| [Pattern 3: Retry with backoff]({{< relref "/develop/clients/error-handling#pattern-3-retry-with-backoff" >}}) |
| ### Pattern 4: Log and continue | ||
|
|
||
| Log non-critical errors and continue (see | ||
| [Pattern 4: Log and continue]({{< relref "/develop/clients/error-handling#pattern-4-log-and-continue" >}}) |
| C -->|Timeout| D(["Retry with<br/>exponential backoff"]) | ||
| C -->|Auth failure| E(["Check credentials<br/>and fail"]) | ||
| C -->|Network error| F(["Fallback to<br/>alternative data source"]) | ||
| ``` |
Comment on lines
+43
to
+46
| | `redis.ConnectionError` | Network or connection issues | Yes | Retry with backoff or fall back to alternative | | ||
| | `redis.TimeoutError` | Operation exceeded timeout | Yes | Retry with backoff | | ||
| | `redis.ResponseError` | Invalid command or Redis error response | No | Fix the command or arguments | | ||
| | `redis.DataError` | Data serialization/deserialization issues | Sometimes | Log, invalidate cache, fetch fresh data | |
There was a problem hiding this comment.
On other pages, you used icons to represent Yes and No. Could you do that here as well?
|
A particular concern is that the overview page contains examples based on Python usage. It seems like Python is close enough to "pseudocode" for this to be a reasonable approach, but let me know if there's a better solution. I think this is okay. It seems that Python is very widely used, so most developers would be able to read it. |
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.
This mainly comes from an investigation into what would help AI generate better code (but we also got at least one human request for more info about error checking). As a bonus feature (again recommended by Augment/ChatGPT), I've added support for Mermaid diagrams to the doc build.
Any feedback about the error categories, examples, Mermaid support, etc, is welcome. A particular concern is that the overview page contains examples based on Python usage. It seems like Python is close enough to "pseudocode" for this to be a reasonable approach, but let me know if there's a better solution.