Skip to content

docs: tag public methods with their sdk-specs capability - #1031

Closed
gewenyu99 wants to merge 1 commit into
feat/markdown-reference-adapterfrom
feat/markdown-reference-tags
Closed

gewenyu99 wants to merge 1 commit into
feat/markdown-reference-adapterfrom
feat/markdown-reference-tags

Conversation

@gewenyu99

@gewenyu99 gewenyu99 commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

💡 Motivation and Context

We have a wave of breaking changes with new major versions for most SDKs. References are now read mostly by bots, not humans, and the HogRef format is heavy. This is part of the stack below.

  • Adds a posthog-capability: line to each public method's doc comment. Comments only.

💚 How did you test it?

  • No code changes.

📝 Checklist

  • All commits are signed
  • I reviewed the submitted code.
  • I added tests to verify the changes.
  • I updated the docs if needed.
  • No breaking change or entry added to the changelog.

🤖 Agent context

Autonomy: Human-driven (agent-assisted)

Claude Code: Sonnet 5.5 built it and Opus 5.5 opened it, directed by Vincent. Not yet reviewed line by line.

Merge order

🤖 Generated with Claude Code

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@gewenyu99 gewenyu99 self-assigned this Nov 5, 2026
@github-actions

github-actions Bot commented Nov 5, 2026

Copy link
Copy Markdown
Contributor

posthog-ios Compliance Report

Date: 2026-11-05T01:12:12.424318+00:00
Duration: 231579ms

⚠️ Some Tests Failed

46/47 tests passed, 1 failed


Capture Tests

⚠️ 29/30 tests passed, 1 failed

View Details
Test Status Duration
Format Validation.Event Has Required Fields ✅ 2803ms
Format Validation.Event Has Uuid ✅ 2724ms
Format Validation.Event Has Lib Properties ✅ 422ms
Format Validation.Distinct Id Is String ✅ 2761ms
Format Validation.Token Is Present ✅ 2738ms
Format Validation.Custom Properties Preserved ✅ 2705ms
Format Validation.Event Has Timestamp ✅ 2729ms
Format Validation.Non Utc Event Timestamp Is Converted To Utc ✅ 2840ms
Retry Behavior.Retries On 503 ✅ 11802ms
Retry Behavior.Does Not Retry On 400 ✅ 4832ms
Retry Behavior.Does Not Retry On 401 ✅ 2400ms
Retry Behavior.Respects Retry After Header ✅ 7731ms
Retry Behavior.Implements Backoff ✅ 21757ms
Retry Behavior.Retries On 500 ✅ 5436ms
Retry Behavior.Retries On 502 ✅ 9353ms
Retry Behavior.Retries On 504 ✅ 9317ms
Retry Behavior.Max Retries Respected ❌ 21336ms
Deduplication.Generates Unique Uuids ✅ 2938ms
Deduplication.Preserves Uuid On Retry ✅ 9390ms
Deduplication.Preserves Uuid And Timestamp On Retry ✅ 16681ms
Deduplication.Preserves Uuid And Timestamp On Batch Retry ✅ 7919ms
Deduplication.No Duplicate Events In Batch ✅ 2991ms
Deduplication.Different Events Have Different Uuids ✅ 2891ms
Compression.Sends Gzip When Enabled ✅ 2845ms
Batch Format.Uses Proper Batch Structure ✅ 2809ms
Batch Format.Flush With No Events Sends Nothing ✅ 248ms
Batch Format.Multiple Events Batched Together ✅ 2834ms
Error Handling.Does Not Retry On 403 ✅ 4888ms
Error Handling.Does Not Retry On 413 ✅ 2394ms
Error Handling.Retries On 408 ✅ 9326ms

Failures

retry_behavior.max_retries_respected

Expected 4 requests, got 6

Feature_Flags Tests

✅ 17/17 tests passed

View Details
Test Status Duration
Request Payload.Request With Person Properties Device Id ✅ 2796ms
Request Payload.Flags Request Uses V2 Query Param ✅ 2736ms
Request Payload.Flags Request Hits Flags Path Not Decide ✅ 2879ms
Request Payload.Flags Request Omits Authorization Header ✅ 2887ms
Request Payload.Token In Flags Body Matches Init ✅ 2760ms
Request Payload.Groups Round Trip ✅ 2752ms
Request Payload.Groups Default To Empty Object ✅ 2717ms
Request Payload.Disable Geoip False Propagates As Geoip Disable False ✅ 2779ms
Request Payload.Disable Geoip Omitted Defaults To False ✅ 2766ms
Request Payload.Flag Keys To Evaluate Contains Only Requested Key ✅ 2871ms
Request Lifecycle.No Flags Request On Init Alone ✅ 100ms
Request Lifecycle.No Flags Request On Normal Capture ✅ 2784ms
Request Lifecycle.Two Flag Calls Produce Two Remote Requests ✅ 5458ms
Request Lifecycle.Mock Response Value Is Returned To Caller ✅ 2840ms
Retry Behavior.Retries Flags On 502 ✅ 2904ms
Retry Behavior.Retries Flags On 504 ✅ 2833ms
Side Effect Events.Get Feature Flag Captures Feature Flag Called Event ✅ 3043ms

@gewenyu99

Copy link
Copy Markdown
Contributor Author

Folded into #1030, so each SDK is two PRs: the code, then the generated pages.

@gewenyu99 gewenyu99 closed this Nov 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant