docker / docker/docker-py

fix extra_hosts in documentation

Open
#1,913 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
7.2k
Forks
1.7k
Avg merge
13d 8h
Merged PRs (30d)
2

Description

Please, specify format extra_hosts in section "run container" in documentation,
Dict format is uncomfortable, because key is hostname, but we can have multiply networks in container, and with dict it imposiible, but i had read docker documentation and try to write ['foo:127.0.102.43', 'bar:23.43.54.1'], result is successful! I had try with any iterable object of the form ['hostname: ip_addr' for item in items] and it works!
I think that it needs to be documented, thank you

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in the documentation section titled "run container" and locate the description of extra_hosts. Document the accepted iterable form using hostname and IP address strings, alongside the existing dict format, and confirm the example matches the behavior described in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.