Doc for Orb.Str.Slice

RoyalIcing · Jun 30, 2024 · d488d54 · d488d54
1 parent 65efc10
commit d488d54
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/orb/str.ex b/lib/orb/str.ex
@@ -58,6 +58,9 @@ defmodule Orb.Str do
   end
 
   defmodule Slice do
+    @moduledoc """
+    A string slice represented as a i64, a compromise for when storing strings as globals (Globals cannot be `(i32 i32)`, only single primitives like `i32` or `i64`).
+    """
     defstruct push_type: __MODULE__, slice64: nil
 
     with @behaviour Orb.CustomType do