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

Reinstate --close-quotes-on-newline #172

Merged
merged 2 commits into from
Aug 24, 2024
Merged

Conversation

glenn-jocher
Copy link
Member

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

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Improved the formatting of code documentation by updating configuration parameters.

πŸ“Š Key Changes

  • Updated docformatter settings to include --close-quotes-on-newline in action.yml.
  • Modified update_markdown_code_blocks.py to utilize the --close-quotes-on-newline parameter.

🎯 Purpose & Impact

  • Improved Readability: Ensures code documentation is neatly formatted, making it easier to read and maintain πŸ“š.
  • Consistent Style: Enforces a uniform style across all documentation, enhancing clarity and professionalism πŸ–‹οΈ.
  • Developer Convenience: Simplifies the review process for developers by automatically handling line breaks and quote closures πŸš€.

@UltralyticsAssistant UltralyticsAssistant added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 24, 2024
@glenn-jocher glenn-jocher changed the title Update action.yml Reinstate --close-quotes-on-newline Aug 24, 2024
@glenn-jocher glenn-jocher merged commit 151821f into main Aug 24, 2024
2 checks passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch August 24, 2024 18:59
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