search

PostHog / posthog-flutter

PostHog Flutter SDK
https://posthog.com/docs/libraries/flutter
MIT License
48 stars 34 forks source link

Add method documentation for Posthog #88

Open marandaneto opened 4 months ago

marandaneto commented 4 months ago

Description

Relates to https://x.com/caseycrogers/status/1763498570307551663?s=20

caseycrogers commented 4 months ago

Motivating example: I want to set when events are associated with a dev device so I can filter that out in my dashboards. debug(true) seems like the obvious thing to do, but when I click through on debug it's not documented so I'm not sure what setting it to true does.

Of course I can reference the web docs (which I'm about to do now to read up on this), but 9 times out of 10 I prefer in-line documentation as it's much less disruptive to my workflow than having to navigate web docs.

marandaneto commented 4 months ago

We'd also benefit from automatically generated API ref. https://pub.dev/documentation/posthog_flutter/latest/index.html