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

Corrected Docs code examples #134

Merged
merged 3 commits into from
May 11, 2024
Merged

Conversation

RizwanMunawar
Copy link
Member

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👋 Hello @RizwanMunawar, thank you for submitting an Ultralytics HUB-SDK 🚀 PR! To allow your work to be integrated as seamlessly as possible, we advise you to:

  • ✅ Verify your PR is up-to-date with ultralytics/hub-sdk main branch. If your PR is behind you can update your code by clicking the 'Update branch' button or by running git pull and git merge main locally.
  • ✅ Verify all Continuous Integration (CI) checks are passing.
  • ✅ Update Docs for any new or updated features.
  • ✅ Reduce changes to the absolute minimum required for your bug fix or feature addition. "It is not daily increase but daily decrease, hack away the unessential. The closer to the source, the less wastage there is." — Bruce Lee

See our Contributing Guide for details and let us know if you have any questions!

@glenn-jocher
Copy link
Member

glenn-jocher commented May 11, 2024

@RizwanMunawar thanks for the PR, the additions look awesome.

@sergiuwaxmann BTW this method to initialize the HUBClient looks terrible to me. Are we really forcing the users to pass a dictionary?? Shouldn't they login/init the client directly with their API_KEY like this?

client = HUBClient("YOUR_API_KEY_HERE")

@yogendrasinghx do you know if the tests are failing due to updates in this PR or could it be a tests issue? The PR is only modifying markdown files so it shouldn't affect actual python code. EDIT: nevermind, just got up to speed on this, trying pull_request_target that Wax recommended!

@glenn-jocher glenn-jocher changed the title Fix code formatting in docs. Corrected Docs code examples May 11, 2024
@glenn-jocher glenn-jocher merged commit a7b30ae into ultralytics:main May 11, 2024
5 checks passed
@glenn-jocher
Copy link
Member

@RizwanMunawar @sergiuwaxmann @yogendrasinghx tests now passing with pull_request_target change (good idea Wax!!).

PR merged!

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

3 participants