Skip to content

docs: Align check/0 version field types with the success result shape #8

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

Merged
zacky1972 merged 1 commit into from
May 15, 2026
Merged

docs: Align check/0 version field types with the success result shape #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions lib/docker_availability.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,15 +62,15 @@ defmodule DockerAvailability do
Result returned by `check/0`.

Successful results contain the resolved Docker executable path and the client
and server version values reported by Docker. Error results contain one of the
and server version strings reported by Docker. Error results contain one of the
documented Docker availability reasons.
"""
@type check_result ::
{:ok,
%{
executable: Path.t(),
client_version: String.t() | nil,
server_version: String.t() | nil
client_version: String.t(),
server_version: String.t()
}}
| {:error, reason()}

Expand Down