From 3c72b38b15a3ac2037fa9b35d325795f6458122e Mon Sep 17 00:00:00 2001 From: Jon Michael Aanes Date: Mon, 27 May 2024 23:32:55 +0200 Subject: [PATCH] Documetation --- fin_defs/__init__.py | 5 +++++ 1 file changed, 5 insertions(+) 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, [])