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

typo: fix typos in log and comment #917

Merged
merged 1 commit into from
Mar 6, 2025

Conversation

popsiclexu
Copy link
Contributor

What type of PR is this?

/kind cleanup

What this PR does / why we need it:
This PR fixes typos
Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:
No functional changes to the code, just improvements to comments and log readability.
Does this PR introduce a user-facing change?:

@lengrongfu
Copy link
Member

a nice fix, thanks!

/lgtm

@wawa0210 wawa0210 requested a review from Copilot March 5, 2025 05:35
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

PR Overview

This PR is a cleanup that fixes typos in comments and log messages, replacing references to Iluvatar with Mthreads.

  • Updated inline comments to reflect the correct product name
  • Updated log messages for clarity and consistency

Reviewed Changes

File Description
pkg/device/mthreads/device.go Corrected typos in comments and log messages

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Copy link

codecov bot commented Mar 5, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Flag Coverage Δ
unittests 64.52% <100.00%> (+17.54%) ⬆️

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

Files with missing lines Coverage Δ
pkg/device/mthreads/device.go 91.42% <100.00%> (+70.12%) ⬆️

... and 10 files with indirect coverage changes

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@wawa0210
Copy link
Member

wawa0210 commented Mar 5, 2025

/kind cleanup

Signed-off-by: popsiclexu <[email protected]>
Co-authored-by: Copilot <[email protected]>
@wawa0210
Copy link
Member

wawa0210 commented Mar 5, 2025

/lgtm

@hami-robott hami-robott bot added the lgtm label Mar 5, 2025
@wawa0210 wawa0210 requested a review from Copilot March 5, 2025 07:41

Choose a reason for hiding this comment

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

PR Overview

This PR fixes typos in comments and log messages to ensure consistency with the Mthreads naming convention.

  • Updates comment labels for MthreadsUseUUID and MthreadsNoUseUUID.
  • Corrects log message references from "Iluvatar" to "Mthreads".

Reviewed Changes

File Description
pkg/device/mthreads/device.go Fix comments and log messages to correctly reference Mthreads

Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

PR Overview

This PR fixes typos in log messages and comments to improve readability.

  • Updated comments for device UUID usage by replacing "Iluvatar" with "Mthreads".
  • Revised log messages to reflect the same terminology change.

Reviewed Changes

File Description
pkg/device/mthreads/device.go Corrected typos in comments and log messages for clarity.

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (2)

pkg/device/mthreads/device.go:43

  • [nitpick] The comment can be improved for clarity. For example: 'MthreadsNoUseUUID indicates that specifying a Mthreads device UUID is not allowed.'
// MthreadsNoUseUUID is user can not use specify Mthreads device for set Mthreads UUID.

pkg/device/mthreads/device.go:181

  • [nitpick] Consider rephrasing the log message for improved clarity, e.g., 'Checking UUID for Mthreads user: [%s], device ID: %s.'
klog.V(5).Infof("check uuid for Mthreads user uuid [%s], device id is %s", userUUID, d.ID)

@@ -38,9 +38,9 @@ const (
MthreadsGPUDevice = "Mthreads"
MthreadsGPUCommonWord = "Mthreads"
MthreadsDeviceSelection = "mthreads.com/gpu-index"
// IluvatarUseUUID is user can use specify Iluvatar device for set Iluvatar UUID.
// MthreadsUseUUID is user can use specify Mthreads device for set Mthreads UUID.
Copy link
Preview

Copilot AI Mar 5, 2025

Choose a reason for hiding this comment

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

[nitpick] The comment is still grammatically awkward. Consider rewording it to 'MthreadsUseUUID allows specifying a Mthreads device UUID.'

Suggested change
// MthreadsUseUUID is user can use specify Mthreads device for set Mthreads UUID.
// MthreadsUseUUID allows specifying a Mthreads device UUID.

Copilot is powered by AI, so mistakes are possible. Review output carefully before use.

Positive Feedback
Negative Feedback

Provide additional feedback

Please help us improve GitHub Copilot by sharing more details about this comment.

Please select one or more of the options
@wawa0210
Copy link
Member

wawa0210 commented Mar 5, 2025

/lgtm
/approve

@archlitchi archlitchi merged commit b81f6ef into Project-HAMi:master Mar 6, 2025
12 of 13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants