openmct icon indicating copy to clipboard operation
openmct copied to clipboard

[CLA Approved] Add returns after JSDoc comments for consistency

Open leonden opened this issue 1 year ago • 5 comments

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.

leonden avatar Feb 15 '24 16:02 leonden

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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%) :arrow_up:
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.

codecov[bot] avatar Feb 15 '24 16:02 codecov[bot]

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!

ozyx avatar Feb 16 '24 17:02 ozyx

@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 avatar Feb 17 '24 08:02 leonden

@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 avatar Feb 20 '24 17:02 ozyx

Hi @leonden:

Good news! Your CLA has been processed and approved.

ozyx avatar Mar 15 '24 20:03 ozyx