Add warning about style change

elixir-explorer · Feb 10, 2025 · f56acd5 · f56acd5
1 parent 2b9a531
commit f56acd5
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/lib/explorer/data_frame.ex b/lib/explorer/data_frame.ex
@@ -6117,6 +6117,12 @@ defmodule Explorer.DataFrame do
 
   This behavior can be overriden with the `:horizontal_style` option to
   `TableRex.Table.render!/2`.
+
+  > #### Warning: Formatting subject to change {: .warning}
+  >
+  > The style that DataFrames are formatted into strings is subject to change.
+  > Please try not to rely on the exact strings returned by this function for
+  > anything critical.
   """
   @doc type: :introspection
   @spec to_table_string(df :: DataFrame.t(), opts :: Keyword.t()) :: String.t()