Skip to content

Commit b80d881

Browse files
committed
Update instrument docstrings
1 parent b008fb3 commit b80d881

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

nautilus_trader/model/instruments/cfd.pyx

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ from nautilus_trader.model.objects cimport Quantity
3434

3535
cdef class Cfd(Instrument):
3636
"""
37-
Represents a generic currency pair instrument in a spot/cash market.
37+
Represents a Contract for Difference (CFD) instrument.
3838
3939
Can represent both Fiat FX and Cryptocurrency pairs.
4040
@@ -45,7 +45,7 @@ cdef class Cfd(Instrument):
4545
raw_symbol : Symbol
4646
The raw/local/native symbol for the instrument, assigned by the venue.
4747
asset_class : AssetClass
48-
The cfd contract asset class.
48+
The CFD contract asset class.
4949
base_currency : Currency, optional
5050
The base currency.
5151
quote_currency : Currency
@@ -119,6 +119,11 @@ cdef class Cfd(Instrument):
119119
If `max_price` is not positive (> 0).
120120
ValueError
121121
If `min_price` is negative (< 0).
122+
123+
References
124+
----------
125+
https://en.wikipedia.org/wiki/Contract_for_difference
126+
122127
"""
123128

124129
def __init__(

nautilus_trader/model/instruments/commodity.pyx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,7 @@ from nautilus_trader.model.objects cimport Quantity
3434

3535
cdef class Commodity(Instrument):
3636
"""
37-
Represents a generic currency pair instrument in a spot/cash market.
38-
39-
Can represent both Fiat FX and Cryptocurrency pairs.
37+
Represents a commodity instrument in a spot/cash market.
4038
4139
Parameters
4240
----------

0 commit comments

Comments
 (0)