docs: more and more docs!

Logflare · May 8, 2024 · 34ae1f8 · 34ae1f8
1 parent 3f28ef1
commit 34ae1f8
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/lib/logflare/sources/rules.ex b/lib/logflare/sources/rules.ex
@@ -13,7 +13,6 @@ defmodule Logflare.Rules do
   alias Logflare.Backends.SourceSup
   alias Logflare.Backends
 
-
   @doc """
   Lists rules for a given Source or Backend
   """
@@ -32,7 +31,7 @@ defmodule Logflare.Rules do
   Creates a rule based on a given attr map.
   If it is a drain rule with an associated backend, it will attempt to start the backend child on SourceSup if it is running.
   """
-  @spec create_rule(map()) ::{:ok, Rule.t()} | {:error, Ecto.Changeset.t()}
+  @spec create_rule(map()) :: {:ok, Rule.t()} | {:error, Ecto.Changeset.t()}
   def create_rule(attrs \\ %{}) do
     %Rule{}
     |> Rule.changeset(attrs)

diff --git a/lib/logflare/utils.ex b/lib/logflare/utils.ex
@@ -29,6 +29,13 @@ defmodule Logflare.Utils do
     )
   end
 
+  @doc """
+  Stringifies an atom map to a string map.
+
+  ### Example
+    iex> stringify_keys(%{test: "data"})
+    %{"test" => "data}
+  """
   @spec stringify_keys(map()) :: map()
   def stringify_keys(map = %{}) do
     map