Skip to content

Improve generated API docs #4466

New issue
New issue
Open
Open
Improve generated API docs#4466
Labels
Component: Docsupdates on getsentry/docs or docstringsDocsQuality Improvement
@antonpirker

Description

@antonpirker
antonpirker
opened on Jun 16, 2025

Our generated API docs 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Component: Docsupdates on getsentry/docs or docstringsDocsQuality Improvement

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions