Skip to content

Commit

Permalink
Minor link correction and moduledoc cleanup (#720)
Browse files Browse the repository at this point in the history
* 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.

* Hide multirange extension's module docs

The module didn't have any real documentation and should have been
hidden.
  • Loading branch information
sorentwo authored Dec 19, 2024
1 parent cebb02f commit 6d9e2ca
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
2 changes: 2 additions & 0 deletions lib/postgrex/extensions/multirange.ex
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
defmodule Postgrex.Extensions.Multirange do
@moduledoc false

import Postgrex.BinaryUtils, warn: false

@behaviour Postgrex.SuperExtension
Expand Down
8 changes: 5 additions & 3 deletions lib/postgrex/simple_connection.ex
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit 6d9e2ca

Please sign in to comment.