Skip to content

Commit dba8097

Browse files
committed
Standardize config option terminology
1 parent 84634b0 commit dba8097

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

RELEASES.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ Released on 22nd October 2024 (UTC).
240240
- Added `Clock.timestamp_us()` method for UNIX timestamps in microseconds (μs)
241241
- Added support for `bbo-1s` and `bbo-1m` quote schemas for Databento adapter (#1990), thanks @faysou
242242
- Added validation for venue `book_type` configuration vs data (prevents an issue where top-of-book data is used when order book data is expected)
243-
- Added `compute_effective_deltas` config setting for `PolymarketDataClientConfig`, reducing snapshot size (`False` by default to maintain current behavior)
243+
- Added `compute_effective_deltas` config option for `PolymarketDataClientConfig`, reducing snapshot size (`False` by default to maintain current behavior)
244244
- Added rate limiter for `WebSocketClient` (#1994), thanks @Pushkarm029
245245
- Added in the money probability field to GreeksData (#1995), thanks @faysou
246246
- Added `on_signal(signal)` handler for custom signal data
@@ -404,8 +404,8 @@ Released on 7th September 2024 (UTC).
404404
- Added `OrderBookDeltas` batching support for `ParquetDataCatalog` (use `data_cls` of `OrderBookDeltas` to batch with the same flags method as live adapters)
405405
- Added `RetryManagerPool` to abstract common retry functionality for all adapters
406406
- Added `InstrumentClose` functionality for `OrderMatchingEngine`, thanks @limx0
407-
- Added `BacktestRunConfig.dispose_on_completion` config setting to control post-run disposal behavior for each internal backtest engine (`True` by default to retain current behavior)
408-
- Added `recv_window_ms` config setting for `BinanceExecClientConfig`
407+
- Added `BacktestRunConfig.dispose_on_completion` config option to control post-run disposal behavior for each internal backtest engine (`True` by default to retain current behavior)
408+
- Added `recv_window_ms` config option for `BinanceExecClientConfig`
409409
- Added `sl_time_in_force` and `tp_time_in_force` parameters to `OrderFactory.bracket(...)` method
410410
- Added custom `client_order_id` parameters to `OrderFactory` methods
411411
- Added support for Binance RSA and Ed25519 API key types (#1908), thanks @NextThread
@@ -423,7 +423,7 @@ Released on 7th September 2024 (UTC).
423423

424424
### Breaking Changes
425425
- Renamed `heartbeat_interval` to `heartbeat_interval_secs` (more explicitly indicates time units)
426-
- Moved `heartbeat_interval_secs` config setting to `MessageBusConfig` (the message bus handles external stream processing)
426+
- Moved `heartbeat_interval_secs` config option to `MessageBusConfig` (the message bus handles external stream processing)
427427
- Changed `WebSocketClient.send_text(...)` to take `data` as `bytes` rather than `str`
428428
- Changed `CryptoPerpetual` Arrow schema to include `multiplier` field
429429
- Changed `CryptoFuture` Arrow schema to include `multiplier` field
@@ -460,9 +460,9 @@ Released on 19th August 2024 (UTC).
460460
- Changed `VolumeWeightedAveragePrice` calculation formula to use each bars "typical" price (#1842), thanks @evgenii-prusov
461461
- Changed `OptionsContract` constructor parameter ordering and Arrow schema (consistently group option kind and strike price)
462462
- Renamed `snapshot_positions_interval` to `snapshot_positions_interval_secs` (more explicitly indicates time units)
463-
- Moved `snapshot_orders` config setting to `ExecEngineConfig` (can now be used for all environment contexts)
464-
- Moved `snapshot_positions` config setting to `ExecEngineConfig` (can now be used for all environment contexts)
465-
- Moved `snapshot_positions_interval_secs` config setting to `ExecEngineConfig` (can now be used for all environment contexts)
463+
- Moved `snapshot_orders` config option to `ExecEngineConfig` (can now be used for all environment contexts)
464+
- Moved `snapshot_positions` config option to `ExecEngineConfig` (can now be used for all environment contexts)
465+
- Moved `snapshot_positions_interval_secs` config option to `ExecEngineConfig` (can now be used for all environment contexts)
466466

467467
### Fixes
468468
- Fixed `Position` exception type on duplicate fill (should be `KeyError` to align with the same error for `Order`)

nautilus_trader/risk/greeks.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ def greeks_key(instrument_id: InstrumentId):
3636

3737
class GreeksCalculatorConfig(ActorConfig, frozen=True):
3838
"""
39-
Configuration settings for the GreeksCalculator actor.
39+
Configuration for ``GreeksCalculator`` actor instances.
4040
4141
Parameters
4242
----------
@@ -70,7 +70,7 @@ class GreeksCalculator(Actor):
7070
Parameters
7171
----------
7272
config : GreeksCalculatorConfig
73-
The configuration settings for the GreeksCalculator.
73+
The configuration for the GreeksCalculator.
7474
7575
Attributes
7676
----------

0 commit comments

Comments
 (0)