dotnet / dotnet/Docker.DotNet

Documentation is misleading about docker for windows

Open
#397 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
2.4k
Forks
416
PR merge metrics
No merged PRs in 30d

Description

In the `README.md` of this repository, it is written:
> or to connect to your local [Docker for Windows](https://docs.docker.com/docker-for-windows/) daemon using named pipes or your local [Docker for Mac](https://docs.docker.com/docker-for-mac/) daemon using Unix sockets:
> ```csharp
> using Docker.DotNet;
> DockerClient client = new DockerClientConfiguration()
> .CreateClient();
> ```

However, AFAIK. the implementation of the ctor of `DockerClientConfiguration` is:
```csharp
public DockerClientConfiguration(
Uri endpoint,
Credentials credentials = null,
TimeSpan defaultTimeout = default (TimeSpan))
{
if (endpoint == (Uri) null)
throw new ArgumentNullException(nameof (endpoint));
this.Credentials = credentials ?? (Credentials) new AnonymousCredentials();
this.EndpointBaseUri = endpoint;
if (!(defaultTimeout != TimeSpan.Zero))
return;
if (defaultTimeout < Timeout.InfiniteTimeSpan)
throw new ArgumentException("Timeout must be greater than Timeout.Infinite", nameof (defaultTimeout));
this.DefaultTimeout = defaultTimeout;
}
```

I don't really see a default constructor here like mentioned in the example, do you think that the `README.md` should be fixed?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.