Update instrument docstrings

nautechsystems · Apr 23, 2024 · b80d881 · b80d881
1 parent b008fb3
commit b80d881
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/nautilus_trader/model/instruments/cfd.pyx b/nautilus_trader/model/instruments/cfd.pyx
@@ -34,7 +34,7 @@ from nautilus_trader.model.objects cimport Quantity
 
 cdef class Cfd(Instrument):
     """
-    Represents a generic currency pair instrument in a spot/cash market.
+    Represents a Contract for Difference (CFD) instrument.
 
     Can represent both Fiat FX and Cryptocurrency pairs.
 
@@ -45,7 +45,7 @@ cdef class Cfd(Instrument):
     raw_symbol : Symbol
         The raw/local/native symbol for the instrument, assigned by the venue.
     asset_class : AssetClass
-        The cfd contract asset class.
+        The CFD contract asset class.
     base_currency : Currency, optional
         The base currency.
     quote_currency : Currency
@@ -119,6 +119,11 @@ cdef class Cfd(Instrument):
         If `max_price` is not positive (> 0).
     ValueError
         If `min_price` is negative (< 0).
+
+    References
+    ----------
+    https://en.wikipedia.org/wiki/Contract_for_difference
+
     """
 
     def __init__(

diff --git a/nautilus_trader/model/instruments/commodity.pyx b/nautilus_trader/model/instruments/commodity.pyx
@@ -34,9 +34,7 @@ from nautilus_trader.model.objects cimport Quantity
 
 cdef class Commodity(Instrument):
     """
-    Represents a generic currency pair instrument in a spot/cash market.
-
-    Can represent both Fiat FX and Cryptocurrency pairs.
+    Represents a commodity instrument in a spot/cash market.
 
     Parameters
     ----------