Skip to content
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.

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

docs(readme): include arguments usage #32

Merged
merged 1 commit into from
Jun 11, 2024

Conversation

rjvitorino
Copy link
Contributor

  • Added examples demonstrating various retry strategies with the retry decorator.
  • Documented all available parameters for the retry function: rate_limit_exception, backoff_increment, and retries.
  • Included advanced usage examples, such as custom backoff increments and retry counts.
  • Added usage examples for asynchronous functions.
  • Updated installation and development setup instructions for clarity.
  • Provided detailed contribution guidelines to assist new contributors.

Closes #2

- Added examples demonstrating various retry strategies with the `retry` decorator.
- Documented all available parameters for the `retry` function: `rate_limit_exception`, `backoff_increment`, and `retries`.
- Included advanced usage examples, such as custom backoff increments and retry counts.
- Added usage examples for asynchronous functions.
- Updated installation and development setup instructions for clarity.
- Provided detailed contribution guidelines to assist new contributors.

Closes pydanny#2
Copy link
Owner

@pydanny pydanny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😮 Wow, thanks so much!

@pydanny pydanny merged commit 10b6ae9 into pydanny:main Jun 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Show all arguments in docs
2 participants