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

Replace inline comments with docstrings #12764

Merged
merged 18 commits into from
Feb 26, 2024
Merged

Replace inline comments with docstrings #12764

merged 18 commits into from
Feb 26, 2024

Conversation

glenn-jocher
Copy link
Member

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

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Refactor and documentation enhancement for the YOLOv5 codebase. πŸ“˜βœ¨

πŸ“Š Key Changes

  • πŸ“ Improved docstrings and comments across multiple files for better clarity and developer guidance.
  • πŸ’‘ Introduced more descriptive initialization method comments in models/experimental.py and other modules.
  • 🧹 Cleaned up and standardized function definitions with clearer explanations of parameters and return values.
  • πŸš€ Enhanced code readability and maintainability throughout the YOLOv5 codebase.

🎯 Purpose & Impact

  • πŸ“– The changes aim to make the YOLOv5 codebase more user-friendly and accessible to developers, easing future contributions and modifications.
  • πŸ‘ Users can now better understand the purpose and usage of individual functions and classes, potentially resulting in fewer issues and questions for maintainers.
  • ⏱️ Some functions, like fuse(), are documented to potentially improve inference speed, bringing performance benefits to end users.

@glenn-jocher glenn-jocher merged commit 574331f into master Feb 26, 2024
8 checks passed
@glenn-jocher glenn-jocher deleted the docstrings2 branch February 26, 2024 22:16
NagatoYuki0943 added a commit to NagatoYuki0943/yolov5-ultralytics that referenced this pull request Feb 28, 2024
Replace inline comments with docstrings (ultralytics#12764)
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.

None yet

2 participants