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

[CLA Approved] Add returns after JSDoc comments for consistency #7505

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

leonden
Copy link

@leonden leonden commented Feb 15, 2024

The changes made in this commit are not tied to a specific issue. I simply added returns to some JSDoc comments for a better consistency inside of the file MCT.js.

Copy link

codecov bot commented Feb 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (4fbccd4) 55.36% compared to head (1956101) 55.38%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #7505      +/-   ##
==========================================
+ Coverage   55.36%   55.38%   +0.02%     
==========================================
  Files         671      671              
  Lines       27010    27010              
  Branches     2631     2631              
==========================================
+ Hits        14954    14960       +6     
+ Misses      11333    11327       -6     
  Partials      723      723              
Flag Coverage Δ *Carryforward flag
e2e-full 41.13% <ø> (ø) Carriedforward from 4fbccd4
e2e-stable 59.38% <ø> (+0.17%) ⬆️
unit 48.44% <ø> (ø)

*This pull request uses carry forward flags. Click here to find out more.

Files Coverage Δ
src/MCT.js 97.00% <ø> (ø)

... and 6 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4fbccd4...1956101. Read the comment docs.

@ozyx ozyx added the source:community Community contribution or request label Feb 15, 2024
@ozyx ozyx changed the title Add returns after JSDoc comments for consistency [CLA Needed] Add returns after JSDoc comments for consistency Feb 15, 2024
@unlikelyzero unlikelyzero self-requested a review February 15, 2024 21:59
Copy link
Collaborator

@unlikelyzero unlikelyzero left a comment

Choose a reason for hiding this comment

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

Thanks for this PR!

Would you mind updating the linting/prettier rules to make this standardized?

@ozyx
Copy link
Contributor

ozyx commented Feb 16, 2024

Would you mind updating the linting/prettier rules to make this standardized?

@leonden Expanding on what @unlikelyzero mentioned here, we would prefer a change that enforces this as a linting or formatting rule across the codebase rather than a single PR changing one file. If that's possible to achieve, we would consider it.

Could you also please do the following:

  1. Create an issue describing the problem and reference it from this PR
  2. Submit a submit a Contributor License Agreement (CLA) (if you haven't already). We will need this in order to approve and merge your code.

Thanks!

@leonden
Copy link
Author

leonden commented Feb 17, 2024

@ozyx I can do that.
I submitted the signed CLA via email.
So should I open a new issue referring to this PR and then make those changes in the eslint config and open a new PR?
Cheers!

@ozyx
Copy link
Contributor

ozyx commented Feb 20, 2024

@ozyx I can do that. I submitted the signed CLA via email. So should I open a new issue referring to this PR and then make those changes in the eslint config and open a new PR? Cheers!

@leonden
Awesome! You can either add those changes to this PR, or open an entirely new one, up to you. Just need that issue linked to this PR (preferably with our PR template as well)

@ozyx ozyx changed the title [CLA Needed] Add returns after JSDoc comments for consistency [CLA Approved] Add returns after JSDoc comments for consistency Mar 15, 2024
@ozyx
Copy link
Contributor

ozyx commented Mar 15, 2024

Hi @leonden:

Good news! Your CLA has been processed and approved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
source:community Community contribution or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants