Skip to content

Commit a618693

Browse files
committed
Update docs
1 parent b749c23 commit a618693

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

docs/concepts/orders.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ The core order types available for the platform are (using the enum values):
2828
- `TRAILING_STOP_MARKET`
2929
- `TRAILING_STOP_LIMIT`
3030

31-
:::note
31+
:::info
3232
NautilusTrader has unified the API for a large set of order types and execution instructions, however
3333
not all of these are available for every exchange. If an order is submitted where an instruction or option
34-
is not available, then the system will not submit the order and an error will be logged with
34+
is not available, then the system will **NOT** submit the order and an error will be logged with
3535
a clear explanatory message.
3636
:::
3737

@@ -150,13 +150,13 @@ examples will leverage an `OrderFactory` from within a `Strategy` context.
150150

151151
[API Reference](https://nautilustrader.io/docs/api_reference/common.html#module-nautilus_trader.common.factories)
152152

153-
:::note
154-
For clarity, any optional parameters will be clearly marked with a comment which includes the default value.
153+
:::info
154+
Any optional parameters will be clearly marked with a comment which includes the default value.
155155
:::
156156

157157
## Order Types
158158

159-
The following order types are available for the platform.
159+
The following describes the order types which are available for the platform with a code example.
160160

161161
### Market
162162

docs/integrations/databento.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -91,13 +91,13 @@ as a venue identifier. You can read more about Databento dataset naming conventi
9191
Of particular note is for CME Globex MDP 3.0 data (`GLBX.MDP3` dataset code), the following
9292
exchanges are all grouped under the `GLBX` venue. These mappings can be determined from the
9393
instruments `exchange` field:
94-
- `CBCM` - **XCME-XCBT inter-exchange spread**
95-
- `NYUM` - **XNYM-DUMX inter-exchange spread**
96-
- `XCBT` - **Chicago Board of Trade (CBOT)**
97-
- `XCEC` - **Commodities Exchange Center (COMEX)**
98-
- `XCME` - **Chicago Mercantile Exchange (CME)**
99-
- `XFXS` - **CME FX Link spread**
100-
- `XNYM` - **New York Mercantile Exchange (NYMEX)**
94+
- `CBCM` - XCME-XCBT inter-exchange spread
95+
- `NYUM` - XNYM-DUMX inter-exchange spread
96+
- `XCBT` - Chicago Board of Trade (CBOT)
97+
- `XCEC` - Commodities Exchange Center (COMEX)
98+
- `XCME` - Chicago Mercantile Exchange (CME)
99+
- `XFXS` - CME FX Link spread**
100+
- `XNYM` - New York Mercantile Exchange (NYMEX)
101101

102102
:::info
103103
Other venue MICs can be found in the `venue` field of responses from the [metadata.list_publishers](https://databento.com/docs/api-reference-historical/metadata/metadata-list-publishers?historical=http&live=python) endpoint.
@@ -133,7 +133,7 @@ See the following Databento docs for further information:
133133
The following section discusses Databento schema -> Nautilus data type equivalence
134134
and considerations.
135135

136-
:::note
136+
:::info
137137
See the Databento [list of fields by schema guide](https://databento.com/docs/knowledge-base/new-users/fields-by-schema).
138138
:::
139139

@@ -307,7 +307,7 @@ trades = loader.from_dbn_file(
307307
catalog.write_data(trades)
308308
```
309309

310-
:::note
310+
:::info
311311
See also the [Data concepts guide](../concepts/data.md).
312312
:::
313313

@@ -318,7 +318,7 @@ There are two `DatabentoLiveClient`s per Databento dataset:
318318
- One for MBO (order book deltas) real-time feeds
319319
- One for all other real-time feeds
320320

321-
:::note
321+
:::warning
322322
There is currently a limitation that all MBO (order book deltas) subscriptions for a dataset have to be made at
323323
node startup, to then be able to replay data from the beginning of the session. If subsequent subscriptions
324324
arrive after start, then an error will be logged (and the subscription ignored).

0 commit comments

Comments
 (0)