Repository navigation
Use correct sync, async and reply arrows in sequence diagrams - #217
Merged
Merged
Conversation
CoAP NON readings and MQTT PUBLISH with no PUBACK are fire-and-forget, so they use the async arrow (-)). The node's update result answers the broker's offer, so it uses the dashed reply arrow. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WHtcxcAiXX6q2Vy7Htviwg
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
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.
Requested by Mark · project thread
Summary
Checked every Mermaid sequence diagram in the repo against UML arrow meaning:
->>is a synchronous call,-->>a reply,-)an async message with no reply.docs/gallery/02_mermaid.md:N->>G: Reading (CoAP NON)becomesN-)G(CoAP NON is fire-and-forget), andG->>B: PUBLISH ...becomesG-)B(no PUBACK is shown). Both the source listing and the rendered copy are updated.examples/poster/release.md:Running 2.1andUpdate failed, still 2.0answer the broker's offer, so they become-->>replies.The other diagrams (VS Code sample, landscape poster, deck slides, design guide, writing guides) already use the arrows correctly and are unchanged.
Generated by Claude Code