diff --git a/fin_defs/__init__.py b/fin_defs/__init__.py index bf65ad7..82c2f16 100644 --- a/fin_defs/__init__.py +++ b/fin_defs/__init__.py @@ -30,6 +30,11 @@ class StockExchange: @enforce_typing.enforce_types @dataclasses.dataclass(frozen=True) class Asset: + """An identifier representing some abstract financial asset. + + Subtypes represent the various asset types in existence, for example fiat + currencies, stocks or even crypto currencies. + """ def names(self) -> list[str]: return COMMON_NAMES.get(self, [])