Skip to content

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

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Apr 9, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
219c24e
Fixed an issue with inaccurate comments.
BobDu Jan 23, 2019
0054f75
Change using generator iterator.
BobDu Apr 19, 2019
82c3e74
Merge branch 'main' into master
BobDu Apr 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docker/api/container.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -844,7 +844,7 @@ def logs(self, container, stdout=True, stderr=True, stream=False,
float (in fractional seconds)

Returns:
(generator or str)
(generator of bytes or bytes)

Raises:
:py:class:`docker.errors.APIError`
Expand Down
2 changes: 1 addition & 1 deletion docker/models/containers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ def logs(self, **kwargs):
float (in nanoseconds)

Returns:
(generator or str): Logs from the container.
(generator of bytes or bytes): Logs from the container.

Raises:
:py:class:`docker.errors.APIError`
Expand Down