ddmee / polling2

Powerful polling utility in Python
https://polling2.readthedocs.io/
MIT License
60 stars 8 forks source link

Update poll step_function param description #74

Closed andrewsosa closed 9 months ago

andrewsosa commented 2 years ago

Changes code example to accurately demonstrate the text of the param description. The description is:

As an example, you can increase the wait time between calling the target function by 10 seconds every iteration until the step is 100 seconds--at which point it should remain constant at 100 seconds

If step reaches 100, then step += 10 becomes 110, and max(110, 100) == 110, so 110 is returned as the next step.

Changing max to min will make the code example accurate.

PS: Thanks for the great library, it's been super useful!

sonarcloud[bot] commented 2 years ago

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information