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

Fix docs typos in callbacks.py #12750

Merged
merged 2 commits into from
Feb 25, 2024
Merged

Conversation

imyhxy
Copy link
Contributor

@imyhxy imyhxy commented Feb 22, 2024

Fix small typos.

The modified lines keep reformatted and revert by 0-composite-3.sh in ultralytics/actions. Conflict between ruff and docformatter, so the console keep saying that there are files have been reformatted.

image

I have read the CLA Document and I hereby sign the CLA

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Refinement of code comments in callback utility.

πŸ“Š Key Changes

  • Corrected a typo in the class docstring.
  • Removed an unnecessary double quote from a method docstring.

🎯 Purpose & Impact

  • πŸ“ These changes improve code readability and documentation clarity.
  • πŸ› οΈ There is no direct impact on YOLOv5 functionality; this is a housekeeping update.

Signed-off-by: imyhxy <imyhxy@gmail.com>
@imyhxy imyhxy changed the title Update callbacks.py Fix docs typos in callbacks.py Feb 22, 2024
@imyhxy
Copy link
Contributor Author

imyhxy commented Feb 22, 2024

image

No reformat happening in this PR's Github Action

Signed-off-by: imyhxy <imyhxy@gmail.com>
@glenn-jocher
Copy link
Member

@imyhxy hello! Thank you for bringing this to our attention. It seems there's a conflict between our formatting tools. We'll look into the issue between ruff and docformatter to ensure consistent formatting in our automated checks. Your effort to improve the documentation is greatly appreciated! πŸ™Œ

For now, please ensure that your local formatting aligns with the project's style guidelines. You can refer to our documentation for guidance on contributing and code style. If you've already signed the CLA and your PR is ready, we'll review it for merging. Thanks again for your contribution to the YOLOv5 community! πŸš€

@glenn-jocher glenn-jocher merged commit ca00c34 into ultralytics:master Feb 25, 2024
8 checks passed
@glenn-jocher
Copy link
Member

@imyhxy awesome, good fixes!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants