currency: fix module by pylint hints

2025-10-31 08:22:32 +01:00 · 2025-02-08 14:32:59 +01:00
parent cdd7149f71
commit ef0974702f
1 changed files with 27 additions and 0 deletions
--- a/superfaktura/enumerations/currency.py
+++ b/superfaktura/enumerations/currency.py
@@ -1,3 +1,30 @@
+"""
+Currency Enumeration.
+
+This module provides an enumeration of currencies that can be used in the SuperFaktura API.
+
+Classes:
+    - Currencies: Enumeration of currencies.
+
+Usage:
+    from superfaktura.enumerations.currency import Currencies
+    currency = Currencies.CZK
+"""
+
+
 class Currencies:
+    """
+    Currency Enumeration.
+
+    This enumeration represents the different currencies that can be used in the SuperFaktura API.
+
+    Values:
+        - CZK: Czech Koruna
+        - EUR: Euro
+
+    Usage:
+        currency = Currencies.CZK
+    """
+
    CZK = "CZK"
    EUR = "EUR"