Skip to content

Fix return type in Container.top() docstring #3371

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix return type in Container.top() docstring #3371

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 @@ -1221,7 +1221,7 @@ def top(self, container, ps_args=None):
ps_args (str): An optional arguments passed to ps (e.g. ``aux``)

Returns:
(str): The output of the top
(dict): The output of the top

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 @@ -460,7 +460,7 @@ def top(self, **kwargs):
ps_args (str): An optional arguments passed to ps (e.g. ``aux``)

Returns:
(str): The output of the top
(dict): The output of the top

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