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 README.md #13283

Merged
merged 2 commits into from
Aug 26, 2024
Merged

Update README.md #13283

merged 2 commits into from
Aug 26, 2024

Conversation

glenn-jocher
Copy link
Member

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

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Minor documentation improvement in codebase by adding missing periods at the end of several docstring comments.

πŸ“Š Key Changes

  • Added periods at the end of docstrings across multiple files for consistency:
    • export.py
    • hubconf.py
    • models/tf.py
    • segment/val.py
    • utils/dataloaders.py
    • utils/loggers/__init__.py
    • utils/loggers/clearml/clearml_utils.py
    • utils/loggers/wandb/wandb_utils.py
    • utils/loss.py
    • utils/metrics.py
    • utils/plots.py
    • utils/segment/general.py
    • utils/segment/metrics.py
    • utils/torch_utils.py
    • utils/triton.py

🎯 Purpose & Impact

  • Purpose:
    • Ensuring that all docstrings follow a consistent style by ending all comments with periods.
  • Impact:
    • Improves readability and professionalism of the documentation.
    • Provides a more standardized look to the codebase, which can help both new and experienced developers understand documentation faster.

glenn-jocher and others added 2 commits August 26, 2024 02:21
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
@UltralyticsAssistant UltralyticsAssistant added the documentation Improvements or additions to documentation label Aug 26, 2024
@glenn-jocher glenn-jocher merged commit b40781b into master Aug 26, 2024
8 checks passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch August 26, 2024 00:37
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