docker / docker/docker-py

Documentation missing for `docker.utils.parse_env_file`

Open
#3,386 0 comments 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

As said in the title, documentation is missing for docker.utils.parse_env_file.

It is still listed as being added in Version 1.4.0 in the changelog, but the accompanying docs link leads to nowhere.

There are no other mentions in the documentation for parse_env_file. (So no mention of a removal.)

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 with the docker.utils.parse_env_file entry referenced by the changelog and inspect the linked API documentation location. Done means the function has an accessible documentation entry and the documentation link no longer leads nowhere.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.