Skip to content

Update incorrect JSDoc annotations#12101

Merged
karrtikr merged 7 commits intomicrosoft:masterfrom
tonybaloney:jsdoc
Jun 18, 2020
Merged

Update incorrect JSDoc annotations#12101
karrtikr merged 7 commits intomicrosoft:masterfrom
tonybaloney:jsdoc

Conversation

@tonybaloney
Copy link
Copy Markdown

@tonybaloney tonybaloney commented Jun 2, 2020 •
edited by karrtikr
Loading

For #12101

Code quality related. This change just updates a few of the JSDoc @param annotations for typescript and javascript files that are either incorrect (wrong argument name), missing, or had typos

  • Pull request represents a single change (i.e. not fixing disparate/unrelated things in a single PR).
  • Title summarizes what is changing.
  • Has a news entry file (remember to thank yourself!).
  • Appropriate comments and documentation strings in the code.

@tonybaloney
Copy link
Copy Markdown
Author

tonybaloney commented Jun 2, 2020

ready for review :-)

@tonybaloney tonybaloney mentioned this pull request Jun 3, 2020
Closed
kimadeline
kimadeline suggested changes Jun 17, 2020
View reviewed changes
Copy link
Copy Markdown

@kimadeline kimadeline left a comment

Choose a reason for hiding this comment

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

Thank you for your PR! There are a few bits here and there that could be tidied up (left comments), other than that looks good to me.

@tonybaloney
Copy link
Copy Markdown
Author

tonybaloney commented Jun 17, 2020

@kimadeline done!

@kimadeline kimadeline self-requested a review June 17, 2020 23:39
karrtikr
karrtikr reviewed Jun 18, 2020
View reviewed changes
karrtikr
karrtikr approved these changes Jun 18, 2020
View reviewed changes
Copy link
Copy Markdown

@karrtikr karrtikr left a comment

Choose a reason for hiding this comment

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

Thanking you on behalf of yourself. LGTM otherwise.

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Jun 18, 2020

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities (and Security Hotspot 4 Security Hotspots to review)
Code Smell A 29 Code Smells

No Coverage information No Coverage information
1.3% 1.3% Duplication

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Jun 18, 2020

Codecov Report

❗ No coverage uploaded for pull request base (master@1a4acc7). Click here to learn what that means.
The diff coverage is 0.00%.

Impacted file tree graph

@@            Coverage Diff            @@
##             master   #12101   +/-   ##
=========================================
  Coverage          ?   60.03%           
=========================================
  Files             ?      657           
  Lines             ?    35575           
  Branches          ?     5003           
=========================================
  Hits              ?    21358           
  Misses            ?    13168           
  Partials          ?     1049
Impacted Files Coverage Δ
src/client/common/process/pythonDaemonPool.ts 68.51% <ø> (ø)
...mentActivationProviders/condaActivationProvider.ts 93.33% <ø> (ø)
src/client/common/types.ts 100.00% <ø> (ø)
src/client/common/utils/cacheUtils.ts 83.33% <ø> (ø)
...interpreter/jupyterInterpreterDependencyService.ts 72.26% <ø> (ø)
...nt/datascience/jupyter/kernels/kernelSelections.ts 89.69% <ø> (ø)
...ient/datascience/jupyter/kernels/kernelSelector.ts 79.86% <ø> (ø)
...lient/datascience/jupyter/kernels/kernelService.ts 53.84% <ø> (ø)
...ension/configuration/launch.json/updaterService.ts 92.30% <ø> (ø)
.../activation/wrapperEnvironmentActivationService.ts 92.77% <ø> (ø)
... and 662 more

Continue to review full report at Codecov.

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

@karrtikr karrtikr merged commit a98be63 into microsoft:master Jun 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@karrtikr karrtikr karrtikr approved these changes

@kimadeline kimadeline kimadeline approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@tonybaloney @codecov-commenter @karrtikr @kimadeline @karthiknadig