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

Add JSDoc to public properties #60

Merged
merged 14 commits into from
Feb 19, 2020
Merged

Add JSDoc to public properties #60

merged 14 commits into from
Feb 19, 2020

Conversation

mroderick
Copy link
Member

@mroderick mroderick commented Feb 5, 2020

This PR adds JSDoc comments to all public properties

It has been validated using the configuration in sinonjs/eslint-config#6, with the instructions in that PR.

Before this PR can go green, the following needs to happen:

@codecov
Copy link

codecov bot commented Feb 5, 2020

Codecov Report

Merging #60 into master will not change coverage.
The diff coverage is 100%.

Impacted file tree graph

@@          Coverage Diff          @@
##           master    #60   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files          18     18           
  Lines          79     79           
=====================================
  Hits           79     79
Flag Coverage Δ
#unit 100% <100%> (ø) ⬆️
Impacted Files Coverage Δ
lib/value-to-string.js 100% <ø> (ø) ⬆️
lib/type-of.js 100% <ø> (ø) ⬆️
lib/global.js 100% <ø> (ø) ⬆️
lib/every.js 100% <ø> (ø) ⬆️
lib/deprecated.js 100% <ø> (ø) ⬆️
lib/function-name.js 100% <ø> (ø) ⬆️
lib/class-name.js 100% <100%> (ø) ⬆️
lib/called-in-order.js 100% <100%> (ø) ⬆️
lib/order-by-first-call.js 100% <100%> (ø) ⬆️

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 ec5ec07...6c3ea90. Read the comment docs.

@mroderick mroderick added this to In progress in Docs 2020 Feb 5, 2020
Copy link
Contributor

@mgred mgred left a comment

Choose a reason for hiding this comment

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

Great Morgan 👍 LGTM, sorry for the long wait 🚀

@mantoni
Copy link
Member

mantoni commented Feb 18, 2020

LGTM, although the linter is failing the build ☝️👮

@mroderick mroderick merged commit 0486d25 into sinonjs:master Feb 19, 2020
Docs 2020 automation moved this from In progress to Done Feb 19, 2020
@mroderick mroderick deleted the jsdoc branch February 19, 2020 11:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Docs 2020
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants