Skip to content

BigQueryDataTransfer [GCP-7722] : add documentation for param paramter #51

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
Draft
HemangChothani wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

BigQueryDataTransfer [GCP-7722] : add documentation for param paramter #51

HemangChothani wants to merge 1 commit into from

Conversation

@HemangChothani
Copy link
Collaborator

@HemangChothani HemangChothani commented Sep 2, 2019 •
edited by IlyaFaer
Loading

IPR 7722

@mf2199 mf2199 requested review from IlyaFaer, emar-kar and sumit-ql and removed request for sangramql September 23, 2019 15:29
mf2199
mf2199 reviewed Sep 23, 2019
View reviewed changes
Copy link
Collaborator

@mf2199 mf2199 left a comment

Choose a reason for hiding this comment

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

IMO, although this doesn't seem to be wrong, I'm not sure whether this is what they would expect to see in the API Documentation. It is possible that the author meant more of a verbal explanation rather than a code snippet. We may need a consensus from more reviewers, so I've asked @IlyaFaer , @emar-kar , and @sumit-ql to share their opinions as well.

@sumit-ql
Copy link

sumit-ql commented Sep 23, 2019

First of all, we should not make any changes in the _pb2.py file. These are autogenerated.
We should add more documentation in field "params" of protobuff message "TransferConfig". (transfer.proto)
The current state of the field is :
// Data transfer specific parameters. ##### add more documentation here
google.protobuf.Struct params = 9;

Now, another thing is, are we allowed to make changes in proto files, i am not sure about it. May be Alex can tell us if we are allowed to modify the proto files as they are super sensitive.

@mf2199
Copy link
Collaborator

mf2199 commented Sep 23, 2019 •
edited
Loading

@sumit-ql 👍
Good catch! I totally overlooked it.

@HemangChothani
Copy link
Collaborator Author

HemangChothani commented Sep 24, 2019 •
edited
Loading

@sumit-ql thanks, even i forgot about the proto files. We are not allowed to make changes in proto files,once i did and #tres refused me, only they are allowed to do that.

@MaxxleLLC
Copy link
Owner

MaxxleLLC commented Sep 24, 2019 •
edited by HemangChothani
Loading

@sumit-ql thanks, even i forgot about the proto files. We are not allowed to make changes in proto files,once i did and #tres refused me, only they are allowed to do that.

Something worth bringing up during our next Google meeting.

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

Reviewers

@mf2199 mf2199 mf2199 left review comments

@emar-kar emar-kar Awaiting requested review from emar-kar

@IlyaFaer IlyaFaer Awaiting requested review from IlyaFaer

@sumit-ql sumit-ql Awaiting requested review from sumit-ql

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

@HemangChothani @sumit-ql @mf2199 @MaxxleLLC