Add docstrings

[glenn-jocher]

🛠️ PR Summary

_{Made with ❤️ by Ultralytics Actions}

🌟 Summary

Enhancements to annotation conversion scripts for YOLO format.

📊 Key Changes

• Added docstrings for functions to improve code documentation.
• Introduced an option to delete .DS_Store files from Apple systems.
• Functions now have explicit functionality comments, making it easier for developers to understand their purpose.
• Additional options in COCO JSON conversion such as segment support and class mapping.

🎯 Purpose & Impact

• 📝 Improved Documentation: Clearer code comments and docstrings help developers and users understand the conversion process between different annotation formats and YOLO.
• 📁 Dataset Cleanup: .DS_Store deletion keeps the dataset directories clean, especially for non-Apple users who might encounter issues with these files.
• 🌐 User Flexibility: The ability to handle segments and class mappings in COCO JSON conversion caters to a wider range of use cases and datasets.
• 🛠️ Better Code Maintenance: With clearer function descriptions, maintaining and updating the codebase will be simpler for contributors.

[sourcery-ai]

PR Type: Documentation

PR Summary: This pull request focuses on enhancing the codebase by adding comprehensive docstrings to various functions across multiple files. These additions aim to improve the readability and maintainability of the code by clearly describing the purpose, functionality, and usage of the functions involved. The changes span across functions responsible for converting JSON annotations to YOLO format, handling file directories, and manipulating image data.

Decision: Comment

📝 Type: 'Documentation' - not supported yet.

• Sourcery currently only approves 'Typo fix' PRs.

✅ Issue addressed: this change correctly addresses the issue or implements the desired feature.

No details provided.

✅ Small diff: the diff is small enough to approve with confidence.

No details provided.

General suggestions:

• Ensure that all newly added docstrings follow a consistent format and style for better readability.
• Consider adding more detailed descriptions in the docstrings where necessary to provide deeper insights into the function's logic or its parameters.
• Review the docstrings for any potential grammatical or typographical errors to maintain professionalism in the code documentation.

Thanks for using Sourcery. We offer it for free for open source projects and would be very grateful if you could help us grow. If you like it, would you consider sharing Sourcery on your favourite social media? ✨

Share Sourcery

• X
• Mastodon
• LinkedIn
• Facebook

---

Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.