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

Add missing docstrings #101

Merged
merged 4 commits into from
Feb 21, 2024
Merged

Add missing docstrings #101

merged 4 commits into from
Feb 21, 2024

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Feb 21, 2024

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Enhancements in documentation and testing for HUB SDK.

πŸ“Š Key Changes

  • Added docstrings to classes and methods across multiple files for better code documentation.
  • Implemented new tests for creating, retrieving, updating, listing, uploading, and deleting datasets, models, and projects using HUBClient.
  • Decorators and helper functions now have descriptive comments to explain their use.

🎯 Purpose & Impact

  • πŸ“ The added docstrings improve code readability and maintainability, making it easier for developers to understand the SDK's functionality.
  • βœ… New tests increase the robustness of the SDK by ensuring key features work as expected, leading to fewer bugs and a more reliable product for users.
  • πŸ§‘β€πŸ’» Clearer comments aid in onboarding new developers or contributors, streamlining the development process.

@kalenmike kalenmike merged commit e4f69f3 into develop Feb 21, 2024
3 checks passed
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