Skip to content

docs: update Python SDK examples#16888

Merged
marandaneto merged 1 commit into
masterfrom
docs/update-python-docs-examples
May 19, 2026
Merged

docs: update Python SDK examples#16888
marandaneto merged 1 commit into
masterfrom
docs/update-python-docs-examples

Conversation

@marandaneto
Copy link
Copy Markdown
Member

@marandaneto marandaneto commented May 19, 2026

Changes

follow up PostHog/posthog-python#581

  • Update Python SDK docs examples for context snippets and exception capture.
  • Clarify context session guidance for linking backend events to frontend sessions.
  • Keep the GeoIP disable_geoip=True|False example compact to show users pass one value or the other.

No screenshots or screen recordings; docs-only changes.

Checklist

  • I've read the docs and/or content style guides.
  • Words are spelled using American English
  • Use relative URLs for internal links
  • I've checked the pages added or changed in the Vercel preview build
  • If I moved a page, I added a redirect in vercel.json

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 19, 2026

Deploy preview

Status Details Updated (UTC)
🟢 Ready View preview May 19, 2026 03:27PM

@marandaneto marandaneto requested a review from a team May 19, 2026 15:12
@github-actions
Copy link
Copy Markdown
Contributor

Vale prose linter → found 0 errors, 26 warnings, 2 suggestions in your markdown

Full report → Copy the linter results into an LLM to batch-fix issues.

Linter being weird? Update the rules!

contents/docs/libraries/python/_snippets/contexts.mdx — 0 errors, 2 warnings, 1 suggestions
Line Severity Message Rule
3:78 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
128:72 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
134:82 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
contents/docs/libraries/python/index.mdx — 0 errors, 24 warnings, 1 suggestions
Line Severity Message Rule
6:18 warning Use 'GitHub' instead of 'github'. Vale.Terms
6:37 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
18:25 warning Avoid trivializing words. 'easy to' can sound dismissive to the reader. PostHogDocs.Trivializers
18:58 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
69:232 warning 'personless' is a possible misspelling. PostHogBase.Spelling
121:4 warning Capitalize 'Feature Flags' for PostHog's product. Use 'Feature flags' for the general industry concept. PostHogBase.ProductNames
121:4 warning 'Feature flags' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
145:8 warning Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. PostHogBase.ProductNames
145:55 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
145:128 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
155:28 warning Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. PostHogBase.ProductNames
155:54 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
161:4 warning Capitalize 'Error Tracking' for PostHog's product. Use 'Error tracking' for the general industry concept. PostHogBase.ProductNames
161:4 warning 'Error tracking' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
195:8 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
195:274 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
197:7 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
223:62 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
223:100 warning Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. PostHogBase.ProductNames
225:117 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
246:5 warning 'Enable TCP keepalive' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
246:16 warning 'keepalive' is a possible misspelling. PostHogBase.Spelling
248:5 warning 'keepalive' is a possible misspelling. PostHogBase.Spelling
256:18 warning 'keepalive' is a possible misspelling. PostHogBase.Spelling
292:4 warning 'Serverless environments (Render/Lambda/...)' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase

@marandaneto marandaneto merged commit 49943b8 into master May 19, 2026
20 checks passed
@marandaneto marandaneto deleted the docs/update-python-docs-examples branch May 19, 2026 17:43
@marandaneto marandaneto mentioned this pull request May 20, 2026
5 tasks
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.

2 participants