-
Notifications
You must be signed in to change notification settings - Fork 535
Add init()
parameters to ApiDocs.
#4100
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## master #4100 +/- ##
==========================================
+ Coverage 79.48% 79.56% +0.07%
==========================================
Files 140 140
Lines 15624 15624
Branches 2651 2651
==========================================
+ Hits 12419 12431 +12
+ Misses 2372 2360 -12
Partials 833 833
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we maybe just link to the docs page?
I'm afraid this will get out of sync.
The code should be single source of truth. In the long run the docs should be generated from the Apidocs in code. (and also this way we can improve how our SDK behaves in IDEs) And also this will make it easier for LLMs to understand how to use our SDK which in the long run will help all those people that will just ask LLMs to integrate Sentry in their project :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok then, let's try it out and see how it goes. :)
Copied the text from docs.sentry.io and added it to the ApiDocs. (some parameters are undocumented, it seems)