Skip to content

Commit 0d92705

Browse files
docs(python): Improve BottleIntegration options docs (#11512)
* docs(python): Improve `BottleIntegration` options docs Specifically, convert the bulleted list to subheadings, and make the wording more specific and clearer. * Apply suggestions from code review Co-authored-by: Alex Krawiec <[email protected]> --------- Co-authored-by: Alex Krawiec <[email protected]>
1 parent 4da6d58 commit 0d92705

File tree

1 file changed

+11
-11
lines changed
  • docs/platforms/python/integrations/bottle

1 file changed

+11
-11
lines changed

docs/platforms/python/integrations/bottle/index.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -73,22 +73,22 @@ sentry_sdk.init(
7373

7474
```
7575

76-
You can pass the following keyword arguments to `BottleIntegration()`:
76+
Each of the following options are supported as keyword arguments to `BottleIntegration()`.
7777

78-
- `transaction_style`:
78+
### `transaction_style`
7979

80-
```python
81-
@app.route("/myurl/<foo>")
82-
def myendpoint():
83-
return "ok"
84-
```
80+
The `transaction_style` option specifies how the transaction name is generated. You can set the option to `"endpoint"` (the default) or `"url"`.
8581

86-
In the above code, you would set the transaction to:
82+
For example, given the following route:
8783

88-
- `/myurl/<foo>` if you set `transaction_style="url"`.
89-
- `myendpoint` if you set `transaction_style="endpoint"`
84+
```python
85+
@app.route("/myurl/<foo>")
86+
def myendpoint():
87+
return "ok"
88+
```
9089

91-
The default is `"endpoint"`.
90+
- If you set `transaction_style="endpoint"`, the transaction name will be `"myendpoint"`, since that is the route handler function's name.
91+
- If you set `transaction_style="url"`, the transaction name will be `"/myurl/<foo>"`, since that is the URL path.
9292

9393
## Supported Versions
9494

0 commit comments

Comments
 (0)