Skip to content

Commit 782899b

Browse files
committed
improve docs
1 parent 86e80e8 commit 782899b

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,20 @@ Once an inconsistent order is detected, Sentinela will track it and periodically
3030
Below is a simplified monitor implementation for this scenario and the real implementation will require more configuration and steps. This example focuses only on the core logic of the monitor to demonstrate how it can be used.
3131

3232
```python
33-
# Each issue represents an order that is still 'awaiting_delivery' while its related shipment is
34-
# already 'completed'.
33+
# Each issue represents an order that is still "awaiting_delivery" while its related
34+
# shipment is already "completed".
3535

3636
def search():
3737
# Queries the database to get the pending orders with completed shipments
38-
# Example: [{'order_id': 123, 'order_status': 'awaiting_delivery', 'shipment_status': 'completed'}, ...]
38+
# Example:
39+
# [
40+
# {
41+
# "order_id": 123,
42+
# "order_status": "awaiting_delivery",
43+
# "shipment_status": "completed",
44+
# },
45+
# ...
46+
# ]
3947
#
4048
# Example SQL:
4149
# select

0 commit comments

Comments
 (0)