Skip to content

Commit

Permalink
Add back ticks to comment (#13)
Browse files Browse the repository at this point in the history
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Documentation**
- Enhanced clarity of the `getDeadline` method documentation in the
`Event` class by improving the description of the `deadline` variable.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
  • Loading branch information
maksimdrachov authored Dec 4, 2024
1 parent c6d852d commit 9e95a3c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion include/olga_scheduler/olga_scheduler.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ class Event : private cavl::Node<Event<TimePoint>>
}

/// Diagnostic accessor for testing. Not intended for normal use.
/// The deadline is TimePoint::min() if the event is not scheduled or canceled.
/// The deadline is `TimePoint::min()` if the event is not scheduled or canceled.
/// It is guaranteed that while an event resides in the tree, it has a valid deadline set.
[[nodiscard]] TimePoint getDeadline() const noexcept { return deadline_; }

Expand Down

0 comments on commit 9e95a3c

Please sign in to comment.