Make it even more obvious that Postgres is the default (#895)

oban-bg · Apr 28, 2023 · de35e8f · de35e8f
1 parent 2eba8c4
commit de35e8f
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/lib/oban/peer.ex b/lib/oban/peer.ex
@@ -27,6 +27,14 @@ defmodule Oban.Peer do
   * `Oban.Peers.Global` — coordinates global locks through distributed Erlang, requires
     distributed Erlang.
 
+  You can specify the peering module to use in your Oban configuration:
+
+      config :my_app, Oban,
+        peer: Oban.Peers.Postgres, # default value
+        ...
+
+  If in doubt, you can call `Oban.config()` to see which module is being used.
+
   ## Examples
 
   Check leadership for the default Oban instance: