Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Apply ruff==0.9.0 formatting #122

Merged
merged 2 commits into from
Jan 10, 2025
Merged

Apply ruff==0.9.0 formatting #122

merged 2 commits into from
Jan 10, 2025

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Jan 10, 2025

This Ultralytics PR reformats this repo with the latest improved Ruff version 0.9.0 formatter.

Learn more about Ultralytics:

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Improved code readability and efficiency in the handling of FAQs, meta descriptions, and author sections within the plugin.

📊 Key Changes

  • Replaced separate variable assignments with more concise := (walrus operator) usage for faq_section and faqs.
  • Made string-related tweaks for consistent and accurate formatting in output logging and HTML generation.

🎯 Purpose & Impact

  • 🧹 Cleaner Code: Improves code maintainability and readability by streamlining conditional logic.
  • Performance Boost: Minor efficiency improvements when processing FAQs or meta data, making the plugin slightly more optimized.
  • 🌟 Enhanced Output: Ensures author and description information is correctly displayed in logs and output.

Overall, these changes refine and polish the plugin with minimal user-facing impact! 🚀

@UltralyticsAssistant UltralyticsAssistant added devops GitHub Devops or MLops enhancement New feature or request labels Jan 10, 2025
@UltralyticsAssistant
Copy link
Member

👋 Hello @glenn-jocher, thank you for submitting an ultralytics/mkdocs 🚀 PR! To ensure a seamless integration of your work, please review the following checklist:

  • Define a Purpose: Clearly explain the purpose of your fix or feature in your PR description, and link to any relevant issues. Ensure your commit messages are clear, concise, and adhere to the project's conventions.
  • Synchronize with Source: Confirm your PR is synchronized with the ultralytics/mkdocs main branch. If it's behind, update it by clicking the 'Update branch' button or by running git pull and git merge main locally.
  • Ensure CI Checks Pass: Verify all Ultralytics Continuous Integration (CI) checks are passing. If any checks fail, please address the issues.
  • Update Documentation: Update the relevant documentation for any new or modified features.
  • Add Tests: If applicable, include or update tests to cover your changes, and confirm that all tests are passing.
  • Sign the CLA: Please ensure you have signed our Contributor License Agreement if this is your first Ultralytics PR by writing "I have read the CLA Document and I sign the CLA" in a new message.
  • Minimize Changes: Limit your changes to the minimum necessary for your bug fix or feature addition. "It is not daily increase but daily decrease, hack away the unessential. The closer to the source, the less wastage there is." — Bruce Lee

For more guidance, please refer to our Contributing Guide. Don’t hesitate to leave a comment if you have any questions. Thank you for contributing to Ultralytics! 🚀


🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

This PR applies ruff==0.9.0 formatting across the repository for consistency and clarity. 🛠️✨

📊 Key Changes

  • Refactored code to conform with the latest Ruff linting rules.
  • Enhanced overall code readability and standard formatting compliance to align with ruff==0.9.0 specifications.

🎯 Purpose & Impact

  • Purpose: Updates the repository to benefit from the enhancements introduced in the latest version of the Ruff formatter.
  • Impact: Ensures consistent formatting and readability across the codebase while reducing future technical debt. 🚀

⚡ Note: This is an automated response to help guide your PR submission process. An Ultralytics engineer will review your contribution and provide additional feedback as needed. Stay tuned, and thank you for being awesome! 😊

@glenn-jocher glenn-jocher merged commit bbe11ba into main Jan 10, 2025
3 checks passed
@glenn-jocher glenn-jocher deleted the refactor-20250110012830 branch January 10, 2025 00:35
@UltralyticsAssistant
Copy link
Member

🎉 Exciting news—your PR has been merged, @glenn-jocher! 🚀 Your thoughtful refinements, from streamlining code readability to optimizing performance, are a testament to the power of incremental progress. Every polished line and efficient tweak helps us build tools that truly shine.✨

As Leonardo da Vinci once said, "Simplicity is the ultimate sophistication." Your contributions embody this spirit, making the complex clearer and the code sharper. Thank you for your dedication—it’s making a real impact! 🙌

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
devops GitHub Devops or MLops enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants