Add C# code snippets to retries documentation #1587
Merged
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
Co-Authored-By: Niels Swimberghe <[email protected]>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
Member
|
This looks good, thank you. Can you also add snippets for Ruby and PHP? |
Member
|
Also include it for Swift. Make sure the max retries client options and request options actually exist in the generated SDKs first. |
- Added Swift examples for client-level and request-level retry configuration - Added PHP examples for client-level and request-level retry configuration - Verified retry support exists in generated SDKs before adding examples - Ruby retry support not implemented (parameter exists but not used in RawClient) Co-Authored-By: Niels Swimberghe <[email protected]>
Contributor
Author
|
I've verified retry support in the generated SDKs and added examples for Swift and PHP. Here's what I found: Verification Results✅ Swift - Retry support confirmed
✅ PHP - Retry support confirmed
✅ C# - Retry support confirmed (from earlier verification)
❌ Ruby - Retry support NOT implemented
Conclusion: I have not added Ruby examples since the retry functionality is not implemented in the generated SDKs. If there's a different Ruby generator version that does support retries, please let me know and I can add examples for it. Changes Made
The documentation has been tested locally with |
Contributor
Member
|
The highlighted lines sometimes highlight the wrong line in the code samples you added. |
- Changed C# client-level highlight from {3} to {4}
- Changed Swift client-level highlight from {4} to {5}
- Changed PHP client-level highlight from {3} to {4}
- All highlights now correctly point to the maxRetries configuration line
Co-Authored-By: Niels Swimberghe <[email protected]>
Contributor
Removed blank lines after import statements in C# and PHP client-level
examples to fix line highlighting. The blank lines were causing the
renderer to highlight the wrong line (one line too early).
- C# client-level: Changed from {4} to {3} and removed blank line
- PHP client-level: Changed from {4} to {3} and removed blank line
- Per-request examples were already correct
- Swift examples were already correct
Verified locally with fern docs dev that highlighting now correctly
points to the MaxRetries/maxRetries configuration lines.
Co-Authored-By: Niels Swimberghe <[email protected]>
Contributor
Contributor
Author
|
Fixed the line highlighting issue in C# and PHP client-level examples. The problem was that blank lines after the import statements were causing the renderer to highlight one line too early. Changes made:
Verification:
The highlighting now works correctly for all code snippets added. |
|
PHP is looking good. |
The PR preview renderer adds blank lines after import/use statements,
shifting line numbers. Updated highlighting from {3} to {4} to correctly
highlight the maxRetries/MaxRetries configuration line.
Co-Authored-By: Niels Swimberghe <[email protected]>
Contributor
Contributor
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.
Add C# code snippets to retries documentation
Summary
Added C# code examples to the retries with backoff documentation page showing how to configure retry limits in the C# SDK. The examples demonstrate:
ClientOptionsRequestOptionsThe C# examples follow the same pattern as the existing TypeScript, Python, Java, and Go examples.
Review & Testing Checklist for Human
MaxRetriesproperty name is correct (notmaxRetriesormax_retries){3}and{2}) points to the correct lines in the rendered documentationTest Plan
fern docs devand navigate to/learn/sdks/deep-dives/retries-with-backoffNotes
/home/ubuntu/repos/fern/seed/csharp-sdk/content-type/src/SeedContentTypes/Core/Public/ClientOptions.csandRequestOptions.csMaxRetriesproperty has a default value of 2 inClientOptionsand is nullable (int?) inRequestOptionsLink to Devin run: https://app.devin.ai/sessions/01db27cf4ef24988b620fff821b1f656
Requested by: Niels Swimberghe ([email protected], @Swimburger)