Documentation for exec_run()
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7.2k
- Forks
- 1.7k
- Avg merge
- 13d 8h
- Merged PRs (30d)
- 2
Description
The default user is an empty string, but the docs say it is root. I had to manually specify the user as root in order to run commands as root on a container object. The privileged flag does not seem to have any use.
https://docker-py.readthedocs.io/en/stable/containers.html#docker.models.containers.Container.exec_run
The relevant documentation appears to be the same in 4.1.0 (installed), stable, and latest.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at Container.exec_run() and its documentation at the linked containers.html section, comparing the documented default user and privileged flag with the behavior reported in the issue. Update the exec_run() documentation to match the supported behavior, then verify the rendered section no longer claims the default user is root and accurately describes privileged.
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
- 45/100