docs: clarify slices

Author: anpawo

frontend/Serialize.py

@@ -38,7 +38,7 @@ def serializeScene(filepath: str) -> str:
     __name__ = "Scene"
     exec(content, globals())
 
-    # Access Globals: `variable` and `stack`
+    # Access Globals: `requiredInputs` and `actionStack`
     g = Global()
 
     # Serialize the instructions to JSON

frontend/input/Input.py

@@ -17,14 +17,18 @@ class Input(ABC):
 
     You cannot create an `Input` from the base class.
 
+    Basic `Inputs`:
     .. code-block:: python
         def image(filepath: str) -> Input: ...
         def video(filepath: str) -> Input: ...
         def text(string: str) -> Input: ...
-        def shape() -> Input: ...
+        def circle(radius: int) -> Input: ...
     """
 
     index: int
+    """
+    Index of the `Input`.
+    """
 
     def __new__(cls, *args, **kwargs) -> Self:
         instance = super().__new__(cls)
@@ -75,23 +79,25 @@ def copy(self) -> Input:
         )
         return cp
 
-    def __getitem__(self, i: int | slice[int, int, None]) -> Slice:
+    def __getitem__(self, i: int | slice[int | None, int | None, None]) -> Slice:
         """
-        Creates a `reference` of the `frames` `s`.
+        Creates a `reference` of the `frames` `i`.
 
         Usefull if you want to apply a `Transformation` to a part of a video.
 
-        Examples
-        --------
+        ---
+        ### Example
         >>> v = video("test.mp4")
-        >>> v[0:20].fade() # Fade-in during the first 20 frames.
-        >>> v.add()
+        >>> v[0:20].fade() # fade in during the first 20 frames.
+        >>> v.add() # adds it to the timeline
+
         """
         if isinstance(i, int):
             s = slice(i, i)
         else:
-            s = i
+            s = slice(i.start or 0, i.stop or -1)
 
+        # `Slice` of `Slice`
         if isinstance(self, Slice):
             start = -1 if s.start == -1 or self.s.start == -1 else self.s.start + s.start
             stop = -1 if s.stop == -1 else self.s.start + s.stop

frontend/transformation/color/Fade.py

@@ -11,6 +11,8 @@ def __init__(self, sides: list[side] = ALL, startOpacity: uint = 0, endOpacity:
         `Fade` from `side`.
 
         Modify `opacity` for a `Fade in` or a `Fade out`.
+
+        Default: `Fade in`.
         """
         self.sides = sides
         self.startOpacity = startOpacity

include/vm/Register.hpp

@@ -41,16 +41,18 @@ class Register
     ///< Variables representing the Inputs currently used in the program
     std::vector<std::shared_ptr<IInput>> _inputs{};
 
-    ///< Instructions to create new Inputs: [[instructionName, [instructionArgs]]]
+    ///< Instructions to create new Inputs: [[instructionName, {instructionArgs}]]
     json::array_t _instructions{};
 
     ///< Each instruction
     const std::map<std::string, std::function<void(const json::object_t &)>> _inputFactory{
         {"Image", [this](const json::object_t &args) { _inputs.push_back(std::make_shared<Image>(args.at("filepath"))); }},
         {"Video", [this](const json::object_t &args) { _inputs.push_back(std::make_shared<Video>(args.at("filepath"))); }},
         {"Copy", [this](const json::object_t &args) { _inputs.push_back(std::shared_ptr<IInput>(_inputs[args.at("input")]->copy())); }},
-        // TODO: Shapes
+        /// TODO: Shapes (Circle, Square)
+        /// TODO: Text (List of char)
+        /// TODO: Formula (not important)
     };
 
-    // TODO: env to keep track of already loaded images. prevent reload everytime
+    /// TODO: env to keep track of already loaded images. prevent reload everytime
 };

src/vm/Register.cpp

@@ -12,6 +12,9 @@
 void Register::updateInstructions(json::array_t&& newInstructions)
 {
     _instructions = std::forward<json::array_t>(newInstructions);
+
+    /// TODO: cache
+    _inputs.clear();
 }
 
 void Register::runNextInstruction()