From 4c8d48c5751b672d11d5c765499f7040b24d3c0d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Bersier?= <loic.bersier1@gmail.com>
Date: Sun, 13 Oct 2024 17:41:55 +0200
Subject: [PATCH] Add doc

---
 lib/HahaCommands/download.ex |  9 +++++++++
 lib/haha_yes/utils.ex        | 22 ++++++++++++++++++++++
 2 files changed, 31 insertions(+)

diff --git a/lib/HahaCommands/download.ex b/lib/HahaCommands/download.ex
index cd051ba..bf5b76e 100644
--- a/lib/HahaCommands/download.ex
+++ b/lib/HahaCommands/download.ex
@@ -21,6 +21,15 @@ defmodule HahaYes.Commands.Download do
     User: h3h3 download https://www.youtube.com/watch?v=ryS7TS_J7KA
 
     Bot: <video file>
+
+    User: h3h3 download https://cdn.discordapp.com/attachments/790701936394633216/1295042668929355816/1295042650113704087.mp4?ex=670d35f9&is=670be479&hm=bf61358b9b6f8c94a14be4e7e3650799ef733331e84d87254b71a098646c4bc2&
+
+    Bot: <video file>
+
+    User: h3h3 download invalid
+
+    Bot: `[generic] Extracting URL: invalid
+    ERROR: [generic] 'invalid' is not a valid URL. Set --default-search "ytsearch" (or run  yt-dlp "ytsearch:invalid" ) to search YouTube`
   """
   def execute(msg, _ws_state, args) do
     url = Enum.at(args, 0)
diff --git a/lib/haha_yes/utils.ex b/lib/haha_yes/utils.ex
index d545ac3..efd469d 100644
--- a/lib/haha_yes/utils.ex
+++ b/lib/haha_yes/utils.ex
@@ -1,4 +1,26 @@
 defmodule HahaYes.Utility do
+  @moduledoc """
+  Various utilities to be reused in commands
+  """
+
+  @doc """
+  Download utility with the format at 480p by default.
+
+  ## Example
+
+    ```
+    iex> HahaYes.Utility.download("https://x.com/i/status/1844841048603783249", "#{System.tmp_dir}/test")
+
+    {:ok, /tmp}/test.mp4
+    ```
+
+    ```
+    iex> HahaYes.Utility.download("invalid", "#{System.tmp_dir}/test")
+
+    {:error, "[generic] Extracting URL: invalid\\nERROR: [generic] 'invalid' is not a valid URL. Set --default-search "ytsearch" (or run  yt-dlp "ytsearch:invalid" ) to search YouTube"}
+    ```
+  """
+
   def download(url, output, format \\ "bestvideo[height<=?480]+bestaudio/best") do
     opt = ["-f", format, url, "-o", "#{output}.%(ext)s", "--force-overwrites", "--playlist-reverse", "--no-playlist", "--remux-video=mp4/webm/mov", "--no-warnings"];