Skip to content
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

Add init() parameters to ApiDocs. #4100

Merged
merged 4 commits into from
Mar 17, 2025

Conversation

antonpirker
Copy link
Member

Copied the text from docs.sentry.io and added it to the ApiDocs. (some parameters are undocumented, it seems)

Copy link

codecov bot commented Feb 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.56%. Comparing base (4c9731b) to head (1200310).
Report is 7 commits behind head on master.

✅ 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              
Files with missing lines Coverage Δ
sentry_sdk/consts.py 92.85% <ø> (ø)

... and 8 files with indirect coverage changes

@antonpirker antonpirker requested a review from sentrivana March 12, 2025 14:45
Copy link
Contributor

@sentrivana sentrivana left a 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.

@antonpirker
Copy link
Member Author

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 :)

Copy link
Contributor

@sentrivana sentrivana left a 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. :)

@antonpirker antonpirker merged commit 5771f3e into master Mar 17, 2025
140 checks passed
@antonpirker antonpirker deleted the antonpirker/apidocs/add-init-parameters branch March 17, 2025 08:49
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.

None yet

2 participants