Skip to content

wrong expression fix Update README.md#17868

Merged
glenn-jocher merged 2 commits intoultralytics:mainfrom
ArtificialZeng:main
Dec 1, 2024
Merged

wrong expression fix Update README.md#17868
glenn-jocher merged 2 commits intoultralytics:mainfrom
ArtificialZeng:main

Conversation

@ArtificialZeng
Copy link
Contributor

@ArtificialZeng ArtificialZeng commented Nov 29, 2024

wrong expression fix

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Minor typographical update in documentation to improve clarity.

📊 Key Changes

  • Replaced "i.e." with "e.g." in the README to correctly convey examples rather than definitions.

🎯 Purpose & Impact

  • 📝 Improved Clarity: Fixes a common misuse of "i.e." to "e.g.", making instructions clearer for readers.
  • 🌍 User-Friendly Docs: Aligns wording with standard English grammar, aiding both native and non-native English speakers.
  • 🛠️ No Functional Changes: Purely a documentation update; existing code and features remain unaffected.

wrong expression fix
@github-actions
Copy link

github-actions bot commented Nov 29, 2024

All Contributors have signed the CLA. ✅
Posted by the CLA Assistant Lite bot.

@UltralyticsAssistant UltralyticsAssistant added the documentation Improvements or additions to documentation label Nov 29, 2024
@UltralyticsAssistant
Copy link
Member

👋 Hello @ArtificialZeng, thank you for submitting an ultralytics/ultralytics 🚀 PR! To ensure a smooth review and integration process for your contribution, please review the following checklist:

  • Define a Purpose: Clearly explain the purpose of your edit in the PR description. Linking to any relevant issues can be helpful. Ensure your commit messages are clear, concise, and in line with the project's conventions.
  • Synchronize with Source: Confirm your PR is synchronized with the latest ultralytics/ultralytics main branch. If it’s outdated, update your branch by selecting 'Update branch' or using git pull and git merge main locally.
  • Ensure CI Checks Pass: Make sure all Ultralytics Continuous Integration (CI) checks have passed. If any checks fail, kindly address them before requesting further review.
  • Minimize Changes: Keep your changes limited to what’s needed for your documentation improvement. Small, precise edits ensure clarity and efficiency in the review process.
  • Sign the CLA: If this is your first contribution, please confirm you’ve signed our Contributor License Agreement (CLA) by writing "I have read the CLA Document and I sign the CLA" in a comment below.

For additional details on contributing to Ultralytics, please check out our Contributing Guide. If you have any questions, feel free to ask here. An Ultralytics team member will review your PR and provide feedback soon. Thank you for helping to improve our documentation and empowering the community! 🚀✨

Made with ❤️ by Ultralytics Actions

@ArtificialZeng
Copy link
Contributor Author

I have read the CLA Document and I sign the CLA

I have read the CLA Document and I sign the CLA

@codecov
Copy link

codecov bot commented Nov 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.01%. Comparing base (00fc95f) to head (d155142).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17868      +/-   ##
==========================================
- Coverage   74.04%   74.01%   -0.04%     
==========================================
  Files         127      127              
  Lines       17098    17098              
==========================================
- Hits        12661    12655       -6     
- Misses       4437     4443       +6     
Flag Coverage Δ
Benchmarks 35.00% <ø> (-0.04%) ⬇️
GPU 39.13% <ø> (ø)
Tests 67.79% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ArtificialZeng
Copy link
Contributor Author

👋 Hello @ArtificialZeng, thank you for submitting an ultralytics/ultralytics 🚀 PR! To ensure a smooth review and integration process for your contribution, please review the following checklist:

  • Define a Purpose: Clearly explain the purpose of your edit in the PR description. Linking to any relevant issues can be helpful. Ensure your commit messages are clear, concise, and in line with the project's conventions.
  • Synchronize with Source: Confirm your PR is synchronized with the latest ultralytics/ultralytics main branch. If it’s outdated, update your branch by selecting 'Update branch' or using git pull and git merge main locally.
  • Ensure CI Checks Pass: Make sure all Ultralytics Continuous Integration (CI) checks have passed. If any checks fail, kindly address them before requesting further review.
  • Minimize Changes: Keep your changes limited to what’s needed for your documentation improvement. Small, precise edits ensure clarity and efficiency in the review process.
  • Sign the CLA: If this is your first contribution, please confirm you’ve signed our Contributor License Agreement (CLA) by writing "I have read the CLA Document and I sign the CLA" in a comment below.

For additional details on contributing to Ultralytics, please check out our Contributing Guide. If you have any questions, feel free to ask here. An Ultralytics team member will review your PR and provide feedback soon. Thank you for helping to improve our documentation and empowering the community! 🚀✨

Made with ❤️ by Ultralytics Actions

I have read the CLA Document and I sign the CLA

@ArtificialZeng
Copy link
Contributor Author

I have read the CLA Document and I sign the CLA

@glenn-jocher
Copy link
Member

@ArtificialZeng ah interesting. i.e. is used widely throughout the repo, we may want to do a wider search and replace.

@glenn-jocher glenn-jocher merged commit 5c2cdb6 into ultralytics:main Dec 1, 2024
dariussingh pushed a commit to dariussingh/ultralytics that referenced this pull request Dec 11, 2024
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.

3 participants