Skip to content

Commit b59e7bd

Browse files
author
FirstUnicorn
committed
docs(troubleshooting): format GitHub issues link as markdown
## Starting point The "Further assistance" section in troubleshooting.md had inconsistent link formatting - three links used markdown format `[text](url)` while the GitHub issues link used plain text with URL. ## Changes Updated docs/source/troubleshooting.md line 122: - From: `- Open issue on GitHub: https://github.com/firstunicorn/python-eventing/issues` - To: `- [Open issue on GitHub](https://github.com/firstunicorn/python-eventing/issues)` Also cleaned up minor whitespace (trailing spaces in SQL example). ## Result All four links in "Further assistance" section now use consistent markdown format, matching Sphinx documentation standards.
1 parent a868b6f commit b59e7bd

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

docs/source/troubleshooting.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Common issues and solutions for `python-eventing` integration.
4141
1. Ensure `IProcessedMessageStore` is configured in consumer:
4242
```python
4343
from messaging.infrastructure import IdempotentConsumerBase
44-
44+
4545
class MyConsumer(IdempotentConsumerBase):
4646
def __init__(self, store: IProcessedMessageStore):
4747
super().__init__(store)
@@ -62,8 +62,8 @@ Common issues and solutions for `python-eventing` integration.
6262
**Solutions:**
6363
1. Check outbox table has unpublished events older than threshold:
6464
```sql
65-
SELECT COUNT(*) FROM outbox_events
66-
WHERE published = false
65+
SELECT COUNT(*) FROM outbox_events
66+
WHERE published = false
6767
AND created_at < NOW() - INTERVAL '5 minutes';
6868
```
6969

@@ -119,4 +119,4 @@ The PyPI distribution name is `python-eventing`, but imports use `messaging`.
119119
- Review [Integration Guide](integration-guide.html) for setup verification
120120
- Check [Debezium CDC Architecture](debezium-cdc-architecture.html) for publishing details
121121
- See [Consumer Transactions](consumer-transactions.html) for idempotency patterns
122-
- Open issue on GitHub: https://github.com/firstunicorn/python-eventing/issues
122+
- [Open issue on GitHub](https://github.com/firstunicorn/python-eventing/issues)

0 commit comments

Comments
 (0)