Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: fix return type docs for container.logs() #2240

Merged
merged 3 commits into from
Apr 9, 2024
Merged

chore: fix return type docs for container.logs() #2240

merged 3 commits into from
Apr 9, 2024

Conversation

BobDu
Copy link
Contributor

@BobDu BobDu commented Jan 23, 2019

In container logs , return is bytes or generator iterator of output bytes , not string , the comments is error.

@GordonTheTurtle
Copy link

Please sign your commits following these rules:
https://github.com/moby/moby/blob/master/CONTRIBUTING.md#sign-your-work
The easiest way to do this is to amend the last commit:

$ git clone -b "master" [email protected]:Bob-Du/docker-py.git somewhere
$ cd somewhere
$ git commit --amend -s --no-edit
$ git push -f

Amending updates the existing PR. You DO NOT need to open a new one.

@BobDu BobDu closed this Jan 23, 2019
@BobDu BobDu reopened this Jan 23, 2019
docker/api/container.py Outdated Show resolved Hide resolved
docker/models/containers.py Outdated Show resolved Hide resolved
@BobDu
Copy link
Contributor Author

BobDu commented Apr 8, 2024

ping @milas

Years have passed, and the issue still exists. Given that this project remains active and is widely used, could you please pay attention to this PR?

@milas
Copy link
Contributor

milas commented Apr 9, 2024

Thank you for the documentation fix.

Pinging on an old PR that has been revised is acceptable but please be respectful. This PR might have existed for 5 years but it was not actually mergeable until recently, as it was missing DCO.

@milas milas changed the title Fixed an issue with inaccurate comments. chore: fix return type docs for container.logs() Apr 9, 2024
@milas milas merged commit b6464db into docker:main Apr 9, 2024
8 of 11 checks passed
adamtheturtle added a commit to adamtheturtle/typeshed that referenced this pull request May 10, 2024
The documentation at
https://docker-py.readthedocs.io/en/stable/containers.html#docker.models.containers.Container.logs
says "generator or str", but docker/docker-py#2240
will change this to say "generator of bytes or bytes".
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants