Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor link correction and moduledoc cleanup #720

Merged
merged 2 commits into from
Dec 19, 2024
Merged

Minor link correction and moduledoc cleanup #720

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
166ab36
Fix async connect caveat link in SimpleConnection
sorentwo Dec 19, 2024
377b17d
Hide multirange extension's module docs
sorentwo Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions lib/postgrex/extensions/multirange.ex
View file
Open in desktop
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
View file
Open in desktop
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
Loading