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

Mkdocs annotations fixes #7600

Merged
merged 2 commits into from Jan 15, 2024
Merged

Mkdocs annotations fixes #7600

merged 2 commits into from Jan 15, 2024

Conversation

glenn-jocher
Copy link
Member

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

Thank you πŸ™ for your contribution to Ultralytics πŸš€! Your effort in enhancing our repositories is greatly appreciated. To streamline the process and assist us in integrating your Pull Request (PR) effectively, please follow these steps:

  1. Check for Existing Contributions: Before submitting, kindly explore existing PRs to ensure your contribution is unique and complementary.

  2. Link Related Issues: If your PR addresses an open issue, please link it in your submission. This helps us better understand the context and impact of your contribution.

  3. Elaborate Your Changes: Clearly articulate the purpose of your PR. Whether it's a bug fix or a new feature, a detailed description aids in a smoother integration process.

  4. Ultralytics Contributor License Agreement (CLA): To uphold the quality and integrity of our project, we require all contributors to sign the CLA. Please confirm your agreement by commenting below:

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

For more detailed guidance and best practices on contributing, refer to our βœ… Contributing Guide. Your adherence to these guidelines ensures a faster and more effective review process.

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Updated documentation for distance calculation, heatmaps, and API usage with code and argument enhancements.

πŸ“Š Key Changes

  • πŸ“ Improved example code blocks with added spaces for readability.
  • πŸ“ Consistent formatting for argument tables (now using backticks for argument names).
  • πŸ–‹οΈ Minor text adjustments for better clarity and documentation standards.

🎯 Purpose & Impact

  • πŸ§‘β€πŸŽ“ Enables easier understanding for developers and users by improving code clarity.
  • πŸ“Š Helps maintain consistency across documentation, enhancing the overall user experience.
  • πŸš€ Potentially reduces confusion and improves usability of the Ultralytics APIs and features.

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Copy link

codecov bot commented Jan 15, 2024

Codecov Report

All modified and coverable lines are covered by tests βœ…

Comparison is base (22651d0) 77.20% compared to head (4f4549f) 39.58%.

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #7600       +/-   ##
===========================================
- Coverage   77.20%   39.58%   -37.62%     
===========================================
  Files         117      117               
  Lines       14332    14332               
===========================================
- Hits        11065     5674     -5391     
- Misses       3267     8658     +5391     
Flag Coverage Ξ”
Benchmarks ?
GPU 39.58% <ΓΈ> (-0.02%) ⬇️
Tests ?

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.

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
@glenn-jocher glenn-jocher merged commit b128254 into main Jan 15, 2024
10 checks passed
@glenn-jocher glenn-jocher deleted the docs branch January 15, 2024 22:37
scosijnilvo pushed a commit to scosijnilvo/yolov8 that referenced this pull request Jan 19, 2024
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
hmurari pushed a commit to hmurari/ultralytics that referenced this pull request Apr 17, 2024
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
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

1 participant