karmada icon indicating copy to clipboard operation
karmada copied to clipboard

cleanup: update relate binding name and comments for ease of understanding

Open XiShanYongYe-Chang opened this issue 1 year ago • 3 comments

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

In the dependencies distributor module, we have two kinds of binding, one is the binding that is followed, and the other is the binding that follows.

We have a clear explanation of these names:

https://github.com/karmada-io/karmada/blob/0084c8a97eba3b9ff3a0a355cbc95531bcb5c634/pkg/dependenciesdistributor/dependencies_distributor.go#L83-L84

But in the code, some places are not named according to such names, which makes us a little confused when reading the code and we need to repeatedly confirm the intent of the code.

Therefore, this PR unified the confusing naming and modified some comments.

In addition, the code uses two words, depended and dependencies, which correspond to the binding that is followed and binding that follows, respectively.

Which issue(s) this PR fixes: Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

NONE

/cc @RainbowMango @chaunceyjiang @whitewindmills

XiShanYongYe-Chang avatar May 23 '24 09:05 XiShanYongYe-Chang

/assign

whitewindmills avatar May 23 '24 09:05 whitewindmills

Codecov Report

Attention: Patch coverage is 13.43284% with 58 lines in your changes are missing coverage. Please review.

Project coverage is 53.33%. Comparing base (2220124) to head (89088a6).

Files Patch % Lines
...ependenciesdistributor/dependencies_distributor.go 13.43% 57 Missing and 1 partial :warning:

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4980   +/-   ##
=======================================
  Coverage   53.33%   53.33%           
=======================================
  Files         252      252           
  Lines       20482    20481    -1     
=======================================
  Hits        10924    10924           
+ Misses       8836     8835    -1     
  Partials      722      722           
Flag Coverage Δ
unittests 53.33% <13.43%> (+<0.01%) :arrow_up:

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

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov-commenter avatar May 23 '24 09:05 codecov-commenter

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: RainbowMango

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment Approvers can cancel approval by writing /approve cancel in a comment

karmada-bot avatar May 25 '24 03:05 karmada-bot