From 166ab366011a9799de30881bd47cc6fe58bb38ce Mon Sep 17 00:00:00 2001 From: Parker Selbert Date: Thu, 19 Dec 2024 14:20:56 +0000 Subject: [PATCH 1/2] Fix async connect caveat link in SimpleConnection The link referenced a module doc anchor as if it was local rather than pointing to the `Postgrex.Notificiations` module where it lives. --- lib/postgrex/simple_connection.ex | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/lib/postgrex/simple_connection.ex b/lib/postgrex/simple_connection.ex index 27e18e73..0f411341 100644 --- a/lib/postgrex/simple_connection.ex +++ b/lib/postgrex/simple_connection.ex @@ -234,9 +234,9 @@ defmodule Postgrex.SimpleConnection do ## Options * `:auto_reconnect` - automatically attempt to reconnect to the database - in event of a disconnection. See the - [note about async connect and auto-reconnects](#module-async-connect-and-auto-reconnects) - above. Defaults to `false`, which means the process terminates. + in event of a disconnection. Defaults to `false`, which means the process + terminates. See the note in `Postgrex.Notifications` about [async connect + and auto-reconnects][async-caveat]. * `:configure` - A function to run before every connect attempt to dynamically configure the options as a `{module, function, args}`, where the current @@ -250,6 +250,8 @@ defmodule Postgrex.SimpleConnection do * `:sync_connect` - controls if the connection should be established on boot or asynchronously right after boot. Defaults to `true`. + + [async-caveat]: Postgrex.Notifications.html#module-async-connect-auto-reconnects-and-missed-notifications """ @spec start_link(module, term, Keyword.t()) :: {:ok, pid} | {:error, Postgrex.Error.t() | term} def start_link(module, args, opts) do From 377b17da894779a9a618af8dc921476f1776c353 Mon Sep 17 00:00:00 2001 From: Parker Selbert Date: Thu, 19 Dec 2024 14:25:15 +0000 Subject: [PATCH 2/2] Hide multirange extension's module docs The module didn't have any real documentation and should have been hidden. --- lib/postgrex/extensions/multirange.ex | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/postgrex/extensions/multirange.ex b/lib/postgrex/extensions/multirange.ex index f644c253..20031bd8 100644 --- a/lib/postgrex/extensions/multirange.ex +++ b/lib/postgrex/extensions/multirange.ex @@ -1,4 +1,6 @@ defmodule Postgrex.Extensions.Multirange do + @moduledoc false + import Postgrex.BinaryUtils, warn: false @behaviour Postgrex.SuperExtension