From 9e998f6fa9f4f5edcfc9ad04b57dd99cb72cd7ee Mon Sep 17 00:00:00 2001
From: Roberto Saccon <rsaccon@gmail.com>
Date: Wed, 6 Dec 2023 11:32:48 +0100
Subject: [PATCH] WIP: added Input options class documentation

---
 api/static/input_options.py | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/api/static/input_options.py b/api/static/input_options.py
index aff4ac6..894dba3 100644
--- a/api/static/input_options.py
+++ b/api/static/input_options.py
@@ -18,6 +18,18 @@ class InputOptions:
     """Input options parent class"""
 
 class IntOptions(InputOptions):
+    """
+    Title.
+    
+    Example descriptions:
+    ```python
+    my_int: Float = IntOptions(
+        default=3,
+        min=1,
+        max=5
+    ),
+    ```
+    """
     MAX = 2147483647
     MIN = -MAX -1
     
@@ -40,6 +52,18 @@ class IntOptions(InputOptions):
         self.hide_in_modifier = hide_in_modifier
 
 class FloatOptions(InputOptions):
+    """
+    Title.
+    
+    Example descriptions:
+    ```python
+    my_float: Float = FloatOptions(
+        default=1.5,
+        min=-0.5,
+        max=2.5
+    ),
+    ```
+    """
     MAX = float('inf')
     MIN = float('-inf')