chore: fix return type docs for container.logs()
#2240
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Please sign your commits following these rules: $ git clone -b "master" git@github.com:Bob-Du/docker-py.git somewhere
$ cd somewhere
$ git commit --amend -s --no-edit
$ git push -fAmending updates the existing PR. You DO NOT need to open a new one. |
ulyssessouza
suggested changes
Mar 15, 2019
Signed-off-by: BobDu <i@bobdu.cc>
Signed-off-by: BobDu <i@bobdu.cc>
|
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
approved these changes
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
changed the title
container.logs()
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".
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In container logs , return is bytes or generator iterator of output bytes , not string , the comments is error.