Fix correlation_id default in publisher docs#15
Merged
Conversation
The publisher.md table claimed `correlation_id` defaults to `auto UUID`, but the code falls back to the resolved `timer_id` (`publisher/usecase.py:73`, `broker.py:189`). Update the default cell to `same as timer_id` and add an admonition explaining the implication for idempotent retries (same `timer_id` → same `correlation_id` across retries). Enable the `admonition` markdown extension in `mkdocs.yml` so the new `!!! note` block renders.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The publisher.md table claimed
correlation_iddefaults toauto UUID, but the code falls back to the resolvedtimer_id(publisher/usecase.py:73,broker.py:189). Update the default cell tosame as timer_idand add an admonition explaining the implication for idempotent retries (sametimer_id→ samecorrelation_idacross retries).Enable the
admonitionmarkdown extension inmkdocs.ymlso the new!!! noteblock renders.