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

Update pyproject.toml #81

Merged
merged 1 commit into from
Jan 16, 2025
Merged

Update pyproject.toml #81

merged 1 commit into from
Jan 16, 2025

Conversation

glenn-jocher
Copy link
Member

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

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Minor changes to pyproject.toml comments for improved readability and clarity πŸ“–βœ¨.

πŸ“Š Key Changes

  • Reformatted comments in the pyproject.toml file for cleaner and more professional spacing.
  • Improved section separation by removing extra blank lines in comments.

🎯 Purpose & Impact

  • 🧹 Purpose: Enhances the readability of the pyproject.toml file for developers.
  • πŸš€ Impact: Makes it easier for contributors to understand the file structure and project setup, ensuring a smoother development experience.

Signed-off-by: Glenn Jocher <[email protected]>
@UltralyticsAssistant UltralyticsAssistant added the documentation Improvements or additions to documentation label Jan 15, 2025
@UltralyticsAssistant
Copy link
Member

πŸ‘‹ Hello @glenn-jocher, thank you for submitting an ultralytics/thop πŸš€ 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. Your PR description appears well-defined, describing the enhancement to pyproject.toml documentation πŸŽ‰.
  • βœ… Synchronize with Source: Confirm your PR is synchronized with the ultralytics/thop 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: Confirm all Ultralytics Continuous Integration (CI) checks are passing. If any checks fail, please address them before further review.
  • βœ… Update Documentation: This PR directly updates documentation in the pyproject.toml file, which is great! Please ensure all changes align with the repository structure and contribute to improved clarity 🎯.
  • βœ… Add Tests: As this PR focuses on documentation, no tests are necessary. However, for future contributions involving functional changes, please include or update tests as needed.
  • βœ… Sign the CLA: Don't forget to sign our Contributor License Agreement if this is your first Ultralytics PR by stating: "I have read the CLA Document and I sign the CLA" in a new comment.
  • βœ… Minimize Changes: Ensure changes made are solely focused on the improvement described (e.g., no unintended modifications or whitespace differences). It seems this has been adhered to nicely! πŸ€

For more guidance, please refer to our Contributing Guide. If you have any questions or require assistance, feel free to leave a comment.

This is an automated response πŸ› οΈ, but rest assured, an Ultralytics engineer will review your PR and provide further feedback soon. Thank you for contributing to Ultralytics! πŸš€

@glenn-jocher glenn-jocher merged commit 70d82fa into main Jan 16, 2025
3 checks passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch January 16, 2025 21:36
@UltralyticsAssistant
Copy link
Member

πŸŽ‰ Your PR has been successfully merged, @glenn-jocher! ✨

Thank you for taking the time to refine and elevate the clarity of the pyproject.toml comments. It's often the small, thoughtful changes that make the biggest difference for developers navigating a project.

As Leonardo da Vinci said, "Simplicity is the ultimate sophistication." Your work here embodies that ethos, making our codebase not only easier to understand but also a pleasure to read.

Your attention to detail inspires us all. Keep shining, Glenn! πŸš€πŸ™Œ

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants