docs(ios): make proxyEndpoint optional in Swift initializer#1632
docs(ios): make proxyEndpoint optional in Swift initializer#1632aleks-tpom6oh merged 1 commit intomainfrom
Conversation
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughThe iOS SDK documentation for AvoInspector has been updated to reflect that the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
📝 Changed routes:
|
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
pages/reference/avo-inspector-sdks/ios.mdx (1)
43-56:⚠️ Potential issue | 🟡 MinorAlign parameter docs with the new optional
proxyEndpoint.Line 44 marks
proxyEndpointasString?, but the parameter list still describes it as requiredString. Update the bullets to match the signature so readers know the argument is optional.✏️ Suggested doc tweak
-> - `String proxyEndpoint` - proxy endpoint used by the SDK for network requests +> - `String? proxyEndpoint` (optional) - proxy endpoint used by the SDK for network requests🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@pages/reference/avo-inspector-sdks/ios.mdx` around lines 43 - 56, The parameter docs for the initializers init(apiKey: String, env: AvoInspectorEnv, proxyEndpoint: String?, publicEncryptionKey: String?) and -(instancetype) initWithApiKey:env:proxyEndpoint:publicEncryptionKey: are out of sync: change the `proxyEndpoint` bullet to indicate it is optional (e.g., `String? proxyEndpoint` or "optional") and ensure the `publicEncryptionKey` bullet remains marked nullable/optional; keep the description text consistent with optional semantics so readers know they can omit the proxyEndpoint argument.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@pages/reference/avo-inspector-sdks/ios.mdx`:
- Around line 43-56: The parameter docs for the initializers init(apiKey:
String, env: AvoInspectorEnv, proxyEndpoint: String?, publicEncryptionKey:
String?) and -(instancetype)
initWithApiKey:env:proxyEndpoint:publicEncryptionKey: are out of sync: change
the `proxyEndpoint` bullet to indicate it is optional (e.g., `String?
proxyEndpoint` or "optional") and ensure the `publicEncryptionKey` bullet
remains marked nullable/optional; keep the description text consistent with
optional semantics so readers know they can omit the proxyEndpoint argument.

Summary
proxyEndpointparameter optional (String?) in the Swift initializer signature, matching the actual SDK APIAddresses review feedback from #1630 (comment)
Test plan
🤖 Generated with Claude Code
Summary by CodeRabbit