`execStart` documentation does not match reality
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- typescript
- Domain
- documentation
Research direction
Read lib/docker-client.ts lines 1630-1678, focusing on the execStart documentation and the null-handling error. Determine whether the documented contract or the observed behavior is authoritative, then make them consistent and verify the resulting documentation or behavior against the existing project checks.
Written by the indexing model from the issue text.
Description
stdout can be null according to the documentation.
https://github.com/docker/node-sdk/blob/47ac3bcd0a6e9f0d4e5a7192e293437ddca0ae55/lib/docker-client.ts#L1630-L1643
But when it is null an error is thrown stating stdout is required to process stream.
https://github.com/docker/node-sdk/blob/47ac3bcd0a6e9f0d4e5a7192e293437ddca0ae55/lib/docker-client.ts#L1647-L1678
- Dominant language
- TypeScript
- Stars
- 107
- Forks
- 12
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
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.
More from docker/node-sdk
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 3/5 1-2 days Newbie friendliness 70/100
-
Podman compatibility Open
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
Similar issues
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
dennys-bd/agent-hive#184 ·
-
Add: hunch Open
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
AbdelStark/awesome-typesafe#104 ·
-
ai-observability bug team/ai-observability
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
vicharanashala/fln#563 ·