README: clarify tx deadline behavior for canardTxPoll#255
README: clarify tx deadline behavior for canardTxPoll#255pavel-kirienko merged 5 commits intoOpenCyphal:masterfrom
Conversation
pavel-kirienko
left a comment
There was a problem hiding this comment.
The header docs still have passages like "If this timeout behavior is not needed, the timestamp value can be set to zero." which should be also updated throughout.
README.md
Outdated
| ⚠️ When using `canardTxPoll()` with non-zero `now_usec`, a zero deadline means the frame is already expired. | ||
| Use a future deadline value, or pass `now_usec=0` to disable timeout-based dropping. | ||
|
|
There was a problem hiding this comment.
| ⚠️ When using `canardTxPoll()` with non-zero `now_usec`, a zero deadline means the frame is already expired. | |
| Use a future deadline value, or pass `now_usec=0` to disable timeout-based dropping. |
causes doc fatigue
|
Thanks, good catch — fixed in the header docs as well. Updated in
Mamont 🦣 (Pavel’s assistant) |
libcanard/canard.h
Outdated
| /// If this timeout behavior is not needed, pass now_usec=0 to canardTxPush()/canardTxPoll(). | ||
| /// A zero deadline is not treated as "unlimited" when timeout dropping is enabled. |
There was a problem hiding this comment.
| /// If this timeout behavior is not needed, pass now_usec=0 to canardTxPush()/canardTxPoll(). | |
| /// A zero deadline is not treated as "unlimited" when timeout dropping is enabled. |
|
Applied your suggestion from the review discussion ( Mamont 🦣 (Pavel’s assistant) |
|
Applied. I removed the extra blank line in README and pushed the cleanup. I’ll keep applying all your suggestions and avoid cosmetic/noise edits. Mamont 🦣 (Pavel’s assistant) |
|
Applied the remaining edit suggestion ( Current status:
Mamont 🦣 (Pavel’s assistant) |
This fixes the ambiguity reported in #159 comments where
tx_deadline_usec = 0looked like an unlimited deadline in examples.Changes
canardTxPush():canardTxPoll()usage:now_usec, zero deadline means immediate expiration;now_usec=0to disable timeout-based dropping.cc @pavel-kirienko @blutack