Skip to content

Commit

Permalink
Standardize further details
Browse files Browse the repository at this point in the history
  • Loading branch information
cjdsellers committed Jun 23, 2024
1 parent 1374485 commit 4308b1c
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 16 deletions.
4 changes: 2 additions & 2 deletions docs/concepts/data.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This inheritance ensures chronological data ordering (vital for backtesting), wh
Consistency is key; data flows through the platform in exactly the same way for all system environment contexts (`backtest`, `sandbox`, `live`)
primarily through the `MessageBus` to the `DataEngine` and onto subscribed or registered handlers.

For those seeking customization, the platform supports user-defined data types. Refer to the advanced [Custom data guide](advanced/custom_data.md) for more details.
For those seeking customization, the platform supports user-defined data types. Refer to the advanced [Custom data guide](advanced/custom_data.md) for further details.

## Loading data

Expand Down Expand Up @@ -210,4 +210,4 @@ data_config = BacktestDataConfig(
```

This configuration object can then be passed into a `BacktestRunConfig` and then in turn passed into a `BacktestNode` as part of a run.
See the [Backtest (high-level API)](../getting_started/backtest_high_level.md) tutorial for more details.
See the [Backtest (high-level API)](../getting_started/backtest_high_level.md) tutorial for further details.
22 changes: 11 additions & 11 deletions docs/concepts/orders.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Orders

This guide provides more details about the available order types for the platform, along with
This guide provides further details about the available order types for the platform, along with
the execution instructions supported for each.

Orders are one of the fundamental building blocks of any algorithmic trading strategy.
Expand Down Expand Up @@ -149,7 +149,7 @@ This leaves the factory with simpler order creation methods to work with, all th
examples will leverage an `OrderFactory` from within a `Strategy` context.

:::info
See the `OrderFactory` [API Reference](../api_reference/common.md#class-orderfactory) for more details.
See the `OrderFactory` [API Reference](../api_reference/common.md#class-orderfactory) for further details.
:::

## Order Types
Expand Down Expand Up @@ -185,7 +185,7 @@ order: MarketOrder = self.order_factory.market(
```

:::info
See the `MarketOrder` [API Reference](../api_reference/model/orders.md#class-marketorder) for more details.
See the `MarketOrder` [API Reference](../api_reference/model/orders.md#class-marketorder) for further details.
:::

### Limit
Expand Down Expand Up @@ -219,7 +219,7 @@ order: LimitOrder = self.order_factory.limit(
```

:::info
See the `LimitOrder` [API Reference](../api_reference/model/orders.md#class-limitorder) for more details.
See the `LimitOrder` [API Reference](../api_reference/model/orders.md#class-limitorder) for further details.
:::

### Stop-Market
Expand Down Expand Up @@ -254,7 +254,7 @@ order: StopMarketOrder = self.order_factory.stop_market(
```

:::info
See the `StopMarketOrder` [API Reference](../api_reference/model/orders.md#class-stopmarketorder) for more details.
See the `StopMarketOrder` [API Reference](../api_reference/model/orders.md#class-stopmarketorder) for further details.
:::

### Stop-Limit
Expand Down Expand Up @@ -291,7 +291,7 @@ order: StopLimitOrder = self.order_factory.stop_limit(
```

:::info
See the `StopLimitOrder` [API Reference](../api_reference/model/orders.md#class-stoplimitorder) for more details.
See the `StopLimitOrder` [API Reference](../api_reference/model/orders.md#class-stoplimitorder) for further details.
:::

### Market-To-Limit
Expand Down Expand Up @@ -322,7 +322,7 @@ order: MarketToLimitOrder = self.order_factory.market_to_limit(
```

:::info
See the `MarketToLimitOrder` [API Reference](../api_reference/model/orders.md#class-markettolimitorder) for more details.
See the `MarketToLimitOrder` [API Reference](../api_reference/model/orders.md#class-markettolimitorder) for further details.
:::

### Market-If-Touched
Expand Down Expand Up @@ -358,7 +358,7 @@ order: MarketIfTouchedOrder = self.order_factory.market_if_touched(
```

:::info
See the `MarketIfTouchedOrder` [API Reference](../api_reference/model/orders.md#class-marketiftouchedorder) for more details.
See the `MarketIfTouchedOrder` [API Reference](../api_reference/model/orders.md#class-marketiftouchedorder) for further details.
:::

### Limit-If-Touched
Expand Down Expand Up @@ -396,7 +396,7 @@ order: StopLimitOrder = self.order_factory.limit_if_touched(
```

:::info
See the `StopLimitOrder` [API Reference](../api_reference/model/orders.md#class-stoplimitorder-1) for more details.
See the `StopLimitOrder` [API Reference](../api_reference/model/orders.md#class-stoplimitorder-1) for further details.
:::

### Trailing-Stop-Market
Expand Down Expand Up @@ -436,7 +436,7 @@ order: TrailingStopMarketOrder = self.order_factory.trailing_stop_market(
```

:::info
See the `TrailingStopMarketOrder` [API Reference](../api_reference/model/orders.md#class-trailingstopmarketorder-1) for more details.
See the `TrailingStopMarketOrder` [API Reference](../api_reference/model/orders.md#class-trailingstopmarketorder-1) for further details.
:::

### Trailing-Stop-Limit
Expand Down Expand Up @@ -479,5 +479,5 @@ order: TrailingStopLimitOrder = self.order_factory.trailing_stop_limit(
```

:::info
See the `TrailingStopLimitOrder` [API Reference](../api_reference/model/orders.md#class-trailingstoplimitorder-1) for more details.
See the `TrailingStopLimitOrder` [API Reference](../api_reference/model/orders.md#class-trailingstoplimitorder-1) for further details.
:::
2 changes: 1 addition & 1 deletion docs/getting_started/backtest_high_level.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@
"id": "10",
"metadata": {},
"source": [
"See the [Loading data](../concepts/data) guide for more details.\n",
"See the [Loading data](../concepts/data) guide for further details.\n",
"\n",
"Next, we simply instantiate a `ParquetDataCatalog` (passing in a directory where to store the data, by default we will just use the current directory).\n",
"We can then write the instrument and tick data to the catalog, it should only take a couple of minutes to load the data (depending on how many months)."
Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started/quickstart.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"!curl https://raw.githubusercontent.com/nautechsystems/nautilus_data/main/nautilus_data/hist_data_to_catalog.py | python -\n",
"```\n",
"\n",
"For more details on how to load data into Nautilus, see [Loading External Data](https://nautilustrader.io/docs/latest/concepts/data#loading-data) guide."
"For further details on how to load data into Nautilus, see [Loading External Data](https://nautilustrader.io/docs/latest/concepts/data#loading-data) guide."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion nautilus_trader/persistence/catalog/parquet.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ class ParquetDataCatalog(BaseDataCatalog):
Notes
-----
For more details about `fsspec` and its filesystem protocols, see
For further details about `fsspec` and its filesystem protocols, see
https://filesystem-spec.readthedocs.io/en/latest/.
"""
Expand Down

0 comments on commit 4308b1c

Please sign in to comment.