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

Top-level API should list possible args/kwargs explicitly #2199

Closed
sentrivana opened this issue Jun 26, 2023 · 0 comments · Fixed by #2213
Closed

Top-level API should list possible args/kwargs explicitly #2199

sentrivana opened this issue Jun 26, 2023 · 0 comments · Fixed by #2213
Assignees
Labels
Component: Docs updates on getsentry/docs or docstrings

Comments

@sentrivana
Copy link
Contributor

sentrivana commented Jun 26, 2023

Problem Statement

Some of the top level API docs only mention **kwargs without any further explanation, so people have to dive into the code themselves.
- e.g. start_span, capture_message

Solution Brainstorm

See if we can expand the kwargs at least in top-level API to the actual arguments.

  • When it comes to user-facing API, user-friendliness should be key. It'd also make code completion possible in IDEs.
  • See if there's a smart way to do this without duplicating code. If not, I guess we can live with some code duplication in the name of making our user-facing API more usable.
  • If not possible, alternatively we should at least include something in the docstring to point the user in the right direction.

See also #2196

@sentrivana sentrivana added enhancement Component: Docs updates on getsentry/docs or docstrings labels Jun 26, 2023
@sentrivana sentrivana added this to the Documentation Improvements milestone Jun 26, 2023
@sentrivana sentrivana self-assigned this Jun 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Docs updates on getsentry/docs or docstrings
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant