fix: no warnings on CHANGELOG when generating docs

codedge-llc · Sep 10, 2024 · 0b4dcbd · 0b4dcbd
1 parent 587362b
commit 0b4dcbd
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/lib/pigeon.ex b/lib/pigeon.ex
@@ -9,7 +9,6 @@ defmodule Pigeon do
     - `Pigeon.ADM` - Amazon Android.
     - `Pigeon.APNS` - Apple iOS.
     - `Pigeon.FCM` - Firebase Cloud Messaging v1 API.
-    - `Pigeon.LegacyFCM` - Firebase Cloud Messaging Legacy API.
 
   ## Creating Dynamic Runtime Dispatchers
 
@@ -97,6 +96,9 @@ defmodule Pigeon do
           notification :: struct | no_return
   @spec push(pid | atom, notifications :: [notification, ...], push_opts) ::
           notifications :: [struct, ...] | no_return
+  @doc """
+  Sends a push notification with given options.
+  """
   def push(pid, notifications, opts \\ [])
 
   def push(pid, notifications, opts) when is_list(notifications) do

diff --git a/mix.exs b/mix.exs
@@ -73,6 +73,7 @@ defmodule Pigeon.Mixfile do
       ],
       formatters: ["html"],
       main: "Pigeon",
+      skip_undefined_reference_warnings_on: ["CHANGELOG.md"],
       source_ref: "v#{@version}",
       source_url: @source_url
     ]