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

Ruff docstring formatting #174

Merged
merged 3 commits into from
Aug 24, 2024
Merged

Ruff docstring formatting #174

merged 3 commits into from
Aug 24, 2024

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Aug 24, 2024

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

This PR updates the Python formatting rules in the Ultralytics GitHub Actions workflow for improved code quality and clarity.

πŸ“Š Key Changes

  • Ignored rules documentation: Added comments explaining ignored rules D100, D104, and D205.
  • Ruff check updates: Now includes extended checks for docstrings and ignores specific rules (D100, D104, and D205) which are commonly missing.

🎯 Purpose & Impact

  • Enhanced Code Quality: By defining and documenting ignored rules, it ensures that important formatting standards are clear and maintained.
  • Clear Documentation: Improved comments will help developers understand the rationale behind ignoring certain rules, making the codebase more maintainable and readable.
  • Streamlined Workflows: Extending Ruff checks and specifying ignored rules helps in maintaining code consistency and reduces unnecessary warnings, simplifying the development process.

@UltralyticsAssistant UltralyticsAssistant added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 24, 2024
@glenn-jocher glenn-jocher merged commit 7227184 into main Aug 24, 2024
2 checks passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch August 24, 2024 19:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants