getsentry / getsentry/sentry-python

Improve generated API docs

Open
#4,466 0 comments 0 reactions 0 assignees View on GitHub
Component: Docs Docs Quality Improvement
Dominant language
Python
Stars
2.2k
Forks
669
Avg merge
1d 1h
Merged PRs (30d)
213

Description

Our [generated API docs](https://getsentry.github.io/sentry-python) need some love.

We should make sure:

- All public API is correct for version 2.x and 3.x of the SDK.
- All public API has a description including description of parameters and return values.
- All cross referencing links are working.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.