Skip to content

Commit

Permalink
doc: can: use :c:macro for K_FOREVER
Browse files Browse the repository at this point in the history
use :c:macro for K_FOREVER instead of a single tick.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
  • Loading branch information
nashif committed May 2, 2020
1 parent 262bf14 commit fc828fd
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/reference/networking/can_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -163,9 +163,9 @@ a mailbox. When a transmitting mailbox is assigned, sending cannot be canceled.
This example shows how to send a frame with extended identifier 0x1234567 and
two bytes of data. The provided callback is called when the message is sent, or
an error occurred. Passing `K_FOREVER` to the timeout causes the function to block
until a transfer mailbox is assigned to the frame or an error occurred. It does
not block until the message is sent like the example above.
an error occurred. Passing :c:macro:`K_FOREVER` to the timeout causes the
function to block until a transfer mailbox is assigned to the frame or an error
occurred. It does not block until the message is sent like the example above.

.. code-block:: C
Expand Down

0 comments on commit fc828fd

Please sign in to comment.