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.

Sign up for GitHub

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

Jump to bottom

docs: various jsdoc fixes #352

Merged
merged 3 commits into from
Oct 2, 2018
Merged

docs: various jsdoc fixes #352

merged 3 commits into from
Oct 2, 2018

Conversation

callmehiphop
Copy link
Contributor

Fixes #345

  • Tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

@callmehiphop callmehiphop requested a review from a team October 2, 2018 08:56
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Oct 2, 2018
@ghost ghost assigned callmehiphop Oct 2, 2018
@callmehiphop callmehiphop mentioned this pull request Oct 2, 2018
Closed
@codecov
Copy link

codecov bot commented Oct 2, 2018 •
edited
Loading

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff            @@
##             master     #352   +/-   ##
=========================================
  Coverage          ?   99.53%           
=========================================
  Files             ?       12           
  Lines             ?     1286           
  Branches          ?        0           
=========================================
  Hits              ?     1280           
  Misses            ?        6           
  Partials          ?        0
Impacted Files Coverage Δ
src/batch-transaction.js 100% <ø> (ø)
src/instance.js 100% <ø> (ø)
src/transaction.js 100% <ø> (ø)
src/session.js 100% <ø> (ø)
src/partial-result-stream.js 100% <ø> (ø)
src/row-builder.js 100% <ø> (ø)
src/codec.js 100% <ø> (ø)
src/index.js 100% <ø> (ø)
src/table.js 100% <100%> (ø)
src/transaction-request.js 100% <100%> (ø)
... and 1 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 ff725af...14e8971. Read the comment docs.

@JustinBeckwith JustinBeckwith merged commit 3d47e54 into googleapis:master Oct 2, 2018
ipotuzhnov
ipotuzhnov reviewed Oct 2, 2018
View reviewed changes
Copy link

@ipotuzhnov ipotuzhnov left a comment

Choose a reason for hiding this comment

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

I'm not sure about the types like error and date, but I guess types in jsdoc could be whatever you want.

src/table.js
@@ -387,7 +386,6 @@ class Table extends TransactionRequest {
*/
/**
* @typedef {array} TableReadResponse
* @property {Table} 0 The new {@link Table}.
* @property {array[]} 1 Rows are returned as an array of object arrays. Each

This comment was marked as spam.

Sign in to view

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ipotuzhnov ipotuzhnov ipotuzhnov left review comments

@JustinBeckwith JustinBeckwith JustinBeckwith approved these changes

@stephenplusplus stephenplusplus stephenplusplus approved these changes

Assignees

@callmehiphop callmehiphop

Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@callmehiphop @JustinBeckwith @stephenplusplus @ipotuzhnov @googlebot