Skip to content

Commit

Permalink
Fix rustdoc links
Browse files Browse the repository at this point in the history
  • Loading branch information
cjdsellers committed Jan 23, 2025
1 parent 490a65c commit e384c6f
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion nautilus_core/model/src/enums.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1229,7 +1229,7 @@ pub enum TriggerType {
DoubleLast = 6,
/// Based on a 'double match' of the bid/ask price for the instrument
DoubleBidAsk = 7,
/// Based on both the [`TriggerType::LastTrade`] and [`TriggerType::BidAsk`].
/// Based on both the [`TriggerType::LastPrice`] and [`TriggerType::BidAsk`].
LastOrBidAsk = 8,
/// Based on the mid-point of the [`TriggerType::BidAsk`].
MidPoint = 9,
Expand Down
2 changes: 1 addition & 1 deletion nautilus_core/model/src/ffi/orderbook/level.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ use crate::{
types::Price,
};

/// C compatible Foreign Function Interface (FFI) for an underlying order book[`Level`].
/// C compatible Foreign Function Interface (FFI) for an underlying order book[`BookLevel`].
///
/// This struct wraps `Level` in a way that makes it compatible with C function
/// calls, enabling interaction with `Level` in a C environment.
Expand Down
4 changes: 2 additions & 2 deletions nautilus_core/model/src/orderbook/level.rs
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ pub struct BookLevel {
}

impl BookLevel {
/// Creates a new [`Level`] instance.
/// Creates a new [`BookLevel`] instance.
#[must_use]
pub fn new(price: BookPrice) -> Self {
Self {
Expand All @@ -52,7 +52,7 @@ impl BookLevel {
}
}

/// Creates a new price level from an order, using the order's price and side.
/// Creates a new [`BookLevel`] from an order, using the order's price and side.
#[must_use]
pub fn from_order(order: BookOrder) -> Self {
let mut level = Self {
Expand Down
2 changes: 1 addition & 1 deletion nautilus_core/network/src/http.rs
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ impl From<String> for HttpClientError {
/// An HTTP client that supports rate limiting and timeouts.
///
/// Built on `reqwest` for async I/O. Allows per-endpoint and default quotas
/// through [`RateLimiter`].
/// through a rate limiter.
///
/// This struct is designed to handle HTTP requests efficiently, providing
/// support for rate limiting, timeouts, and custom headers. The client is
Expand Down
2 changes: 1 addition & 1 deletion nautilus_core/network/src/websocket.rs
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
//! **Design**:
//! - Single reader, multiple writer model
//! - Read half runs in dedicated task
//! - Write half protected by Arc<Mutex>
//! - Write half protected by `Arc<Mutex>`
//! - Controller task manages lifecycle
use std::{
Expand Down
4 changes: 2 additions & 2 deletions nautilus_trader/core/includes/model.h
Original file line number Diff line number Diff line change
Expand Up @@ -825,7 +825,7 @@ typedef enum TriggerType {
*/
DOUBLE_BID_ASK = 7,
/**
* Based on both the [`TriggerType::LastTrade`] and [`TriggerType::BidAsk`].
* Based on both the [`TriggerType::LastPrice`] and [`TriggerType::BidAsk`].
*/
LAST_OR_BID_ASK = 8,
/**
Expand Down Expand Up @@ -1663,7 +1663,7 @@ typedef struct OrderBook_API {
} OrderBook_API;

/**
* C compatible Foreign Function Interface (FFI) for an underlying order book[`Level`].
* C compatible Foreign Function Interface (FFI) for an underlying order book[`BookLevel`].
*
* This struct wraps `Level` in a way that makes it compatible with C function
* calls, enabling interaction with `Level` in a C environment.
Expand Down
4 changes: 2 additions & 2 deletions nautilus_trader/core/rust/model.pxd
Original file line number Diff line number Diff line change
Expand Up @@ -439,7 +439,7 @@ cdef extern from "../includes/model.h":
DOUBLE_LAST # = 6,
# Based on a 'double match' of the bid/ask price for the instrument
DOUBLE_BID_ASK # = 7,
# Based on both the [`TriggerType::LastTrade`] and [`TriggerType::BidAsk`].
# Based on both the [`TriggerType::LastPrice`] and [`TriggerType::BidAsk`].
LAST_OR_BID_ASK # = 8,
# Based on the mid-point of the [`TriggerType::BidAsk`].
MID_POINT # = 9,
Expand Down Expand Up @@ -920,7 +920,7 @@ cdef extern from "../includes/model.h":
cdef struct OrderBook_API:
OrderBook *_0;

# C compatible Foreign Function Interface (FFI) for an underlying order book[`Level`].
# C compatible Foreign Function Interface (FFI) for an underlying order book[`BookLevel`].
#
# This struct wraps `Level` in a way that makes it compatible with C function
# calls, enabling interaction with `Level` in a C environment.
Expand Down

0 comments on commit e384c6f

Please sign in to comment.