Skip to content

Commit d1bbcab

Browse files
committed
Standardize new method docs
1 parent 26464dc commit d1bbcab

16 files changed

+17
-17
lines changed

nautilus_core/common/src/timer.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ pub struct TestTimer {
130130
}
131131

132132
impl TestTimer {
133-
/// Creates a new `TestTimer`.
133+
/// Creates a new `TestTimer` instance.
134134
pub fn new(
135135
name: &str,
136136
interval_ns: u64,
@@ -233,7 +233,7 @@ pub struct LiveTimer {
233233
}
234234

235235
impl LiveTimer {
236-
/// Creates a new `LiveTimer`.
236+
/// Creates a new `LiveTimer` instance.
237237
pub fn new(
238238
name: &str,
239239
interval_ns: u64,

nautilus_core/core/src/uuid.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ pub struct UUID4 {
4343
}
4444

4545
impl UUID4 {
46-
/// Creates a new `UUID4`.
46+
/// Creates a new `UUID4` instance.
4747
#[must_use]
4848
pub fn new() -> Self {
4949
let uuid = Uuid::new_v4();

nautilus_core/model/src/identifiers/account_id.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ use super::venue::Venue;
3939
pub struct AccountId(Ustr);
4040

4141
impl AccountId {
42-
/// Creates a new `AccountId` instance from the given identifier value.
42+
/// Creates a new `AccountId` instance.
4343
///
4444
/// # Panics
4545
///

nautilus_core/model/src/identifiers/client_id.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ use ustr::Ustr;
3131
pub struct ClientId(Ustr);
3232

3333
impl ClientId {
34-
/// Creates a new `ClientId` instance from the given identifier value.
34+
/// Creates a new `ClientId` instance.
3535
///
3636
/// # Panics
3737
///

nautilus_core/model/src/identifiers/client_order_id.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ use ustr::Ustr;
3131
pub struct ClientOrderId(Ustr);
3232

3333
impl ClientOrderId {
34-
/// Creates a new `ClientOrderId` instance from the given identifier value.
34+
/// Creates a new `ClientOrderId` instance.
3535
///
3636
/// # Panics
3737
///

nautilus_core/model/src/identifiers/component_id.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ use ustr::Ustr;
3131
pub struct ComponentId(Ustr);
3232

3333
impl ComponentId {
34-
/// Creates a new `ComponentId` instance from the given identifier value.
34+
/// Creates a new `ComponentId` instance.
3535
///
3636
/// # Panics
3737
///

nautilus_core/model/src/identifiers/exec_algorithm_id.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ use ustr::Ustr;
3131
pub struct ExecAlgorithmId(Ustr);
3232

3333
impl ExecAlgorithmId {
34-
/// Creates a new `ExecAlgorithmId` instance from the given identifier value.
34+
/// Creates a new `ExecAlgorithmId` instance.
3535
///
3636
/// # Panics
3737
///

nautilus_core/model/src/identifiers/instrument_id.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ pub struct InstrumentId {
4040
}
4141

4242
impl InstrumentId {
43-
/// Creates a new `InstrumentId` instance from the given `Symbol` and `Venue`.
43+
/// Creates a new `InstrumentId` instance.
4444
#[must_use]
4545
pub fn new(symbol: Symbol, venue: Venue) -> Self {
4646
Self { symbol, venue }

nautilus_core/model/src/identifiers/order_list_id.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ use ustr::Ustr;
3131
pub struct OrderListId(Ustr);
3232

3333
impl OrderListId {
34-
/// Creates a new `OrderListId` instance from the given identifier value.
34+
/// Creates a new `OrderListId` instance.
3535
///
3636
/// # Panics
3737
///

nautilus_core/model/src/identifiers/position_id.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ use ustr::Ustr;
3131
pub struct PositionId(Ustr);
3232

3333
impl PositionId {
34-
/// Creates a new `PositionId` instance from the given identifier value.
34+
/// Creates a new `PositionId` instance.
3535
///
3636
/// # Panics
3737
///

nautilus_core/model/src/identifiers/strategy_id.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ const EXTERNAL_STRATEGY_ID: &str = "EXTERNAL";
4040
pub struct StrategyId(Ustr);
4141

4242
impl StrategyId {
43-
/// Creates a new `StrategyId` instance from the given identifier value.
43+
/// Creates a new `StrategyId` instance.
4444
///
4545
/// # Panics
4646
///

nautilus_core/model/src/identifiers/symbol.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ use ustr::Ustr;
3131
pub struct Symbol(Ustr);
3232

3333
impl Symbol {
34-
/// Creates a new `Symbol` instance from the given identifier value.
34+
/// Creates a new `Symbol` instance.
3535
///
3636
/// # Panics
3737
///

nautilus_core/model/src/identifiers/trade_id.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ pub struct TradeId {
4545
}
4646

4747
impl TradeId {
48-
/// Creates a new `TradeId` instance from the given identifier value.
48+
/// Creates a new `TradeId` instance.
4949
///
5050
/// # Panics
5151
///

nautilus_core/model/src/identifiers/trader_id.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ use ustr::Ustr;
3737
pub struct TraderId(Ustr);
3838

3939
impl TraderId {
40-
/// Creates a new `TraderId` instance from the given identifier value.
40+
/// Creates a new `TraderId` instance.
4141
///
4242
/// # Panics
4343
///

nautilus_core/model/src/identifiers/venue.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ pub const SYNTHETIC_VENUE: &str = "SYNTH";
3535
pub struct Venue(Ustr);
3636

3737
impl Venue {
38-
/// Creates a new `Venue` instance from the given identifier value.
38+
/// Creates a new `Venue` instance.
3939
///
4040
/// # Panics
4141
///

nautilus_core/model/src/identifiers/venue_order_id.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ use ustr::Ustr;
3131
pub struct VenueOrderId(Ustr);
3232

3333
impl VenueOrderId {
34-
/// Creates a new `VenueOrderId` instance from the given identifier value.
34+
/// Creates a new `VenueOrderId` instance.
3535
///
3636
/// # Panics
3737
///

0 commit comments

Comments
 (0)