Core or SDK?
Platform/SDK
Which part? Which one?
Python
Description
For this instance I was attempting to look up documentation on the push_scope context manager. This naturally led me to this page https://docs.sentry.io/platforms/python/enriching-events/scopes/ which I know is incomplete because I'm specifically looking for details about setting the scope's fingerprint.
It took me longer than necessary to finally find this information under a totally different section here https://docs.sentry.io/platforms/python/usage/sdk-fingerprinting/ that doesn't even talk about scopes, but just happens to use push_scope in the example.
I find the sentry documentation extremely frustrating because everything is done through examples that often don't go into the full capabilities of the topic it is demonstrating. There is no Python SDK reference that I can find that lists and provides detail on all the classes, methods, functions, and attributes.
Every time I have to look up something in the sentry documentation it is an easter egg hunt that takes too much time.
Suggested Solution
Please add a Python SDK reference (or at least an index) that documents all classes, methods, functions, attributes, etc.
The examples are good. They are short and simple to follow. But examples isn't documentation.
Core or SDK?
Platform/SDK
Which part? Which one?
Python
Description
For this instance I was attempting to look up documentation on the
push_scopecontext manager. This naturally led me to this page https://docs.sentry.io/platforms/python/enriching-events/scopes/ which I know is incomplete because I'm specifically looking for details about setting the scope's fingerprint.It took me longer than necessary to finally find this information under a totally different section here https://docs.sentry.io/platforms/python/usage/sdk-fingerprinting/ that doesn't even talk about scopes, but just happens to use
push_scopein the example.I find the sentry documentation extremely frustrating because everything is done through examples that often don't go into the full capabilities of the topic it is demonstrating. There is no Python SDK reference that I can find that lists and provides detail on all the classes, methods, functions, and attributes.
Every time I have to look up something in the sentry documentation it is an easter egg hunt that takes too much time.
Suggested Solution
Please add a Python SDK reference (or at least an index) that documents all classes, methods, functions, attributes, etc.
The examples are good. They are short and simple to follow. But examples isn't documentation.