Skip to content

Commit

Permalink
docs: specify units for log_time and publish_time (#1235)
Browse files Browse the repository at this point in the history
  • Loading branch information
kirillmorozov committed Sep 12, 2024
1 parent a7aac13 commit 6a2fe35
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions python/mcap/mcap/writer.py
Original file line number Diff line number Diff line change
Expand Up @@ -169,9 +169,10 @@ def add_message(
:param channel_id: The id of the channel to which the message should be added.
:param sequence: Optional message counter assigned by publisher.
:param log_time: Time at which the message was recorded.
:param publish_time: Time at which the message was published. If not available, must be set
to the log time.
:param log_time: Time at which the message was recorded as nanoseconds since a
user-understood epoch (i.e unix epoch, robot boot time, etc.).
:param publish_time: Time at which the message was published as nanoseconds since a
user-understood epoch (i.e unix epoch, robot boot time, etc.).
:param data: Message data, to be decoded according to the schema of the channel.
"""
message = Message(
Expand Down

0 comments on commit 6a2fe35

Please sign in to comment.