Skip to content

Conversation

@aniketmaurya
Copy link
Collaborator

What does this PR do?

Add more comprehensive docstrings which is developer friendly.

Before submitting
  • Was this discussed/agreed via a Github issue? (no need for typos and docs improvements)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure to update the docs?
  • Did you write any new necessary tests?

PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in GitHub issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃

… detailed configuration options. Updated the initialization docstring to clarify API setup, hardware configuration, performance scaling, and advanced settings. Included quick start examples for basic, production, and multi-model serving scenarios.
@codecov
Copy link

codecov bot commented Jun 12, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85%. Comparing base (a7b5910) to head (07636b2).
Report is 5 commits behind head on main.

Additional details and impacted files
@@         Coverage Diff         @@
##           main   #545   +/-   ##
===================================
  Coverage    85%    85%           
===================================
  Files        38     38           
  Lines      2901   2901           
===================================
  Hits       2479   2479           
  Misses      422    422           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@aniketmaurya aniketmaurya merged commit 78a6ecf into main Jun 12, 2025
20 checks passed
@aniketmaurya aniketmaurya deleted the improve-docstrings branch June 12, 2025 11:54
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.

2 participants