Skip to content

auto-cherry-pick: [v4.13] TimeoutSampler - update docstring #1154

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 1 commit into from
Mar 28, 2023
Merged

auto-cherry-pick: [v4.13] TimeoutSampler - update docstring #1154

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
6 changes: 3 additions & 3 deletions ocp_resources/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ class TimeoutSampler:
"""
Samples the function output.

This is a generator object that at first yields the output of function
`func`. After the yield, it either raises instance of `TimeoutExpiredError` or
This is a generator object that at first yields the output of callable.
After the yield, it either raises instance of `TimeoutExpiredError` or
sleeps `sleep` seconds.

Yielding the output allows you to handle every value as you wish.
Expand Down Expand Up @@ -61,7 +61,7 @@ class BExampleError(AExampleError)
Args:
wait_timeout (int): Time in seconds to wait for func to return a value equating to True
sleep (int): Time in seconds between calls to func
func (function): to be wrapped by TimeoutSampler
func (Callable): to be wrapped by TimeoutSampler
exceptions_dict (dict): Exception handling definition
print_log (bool): Print elapsed time to log
"""
Expand Down