Skip to content
This repository was archived by the owner on Feb 7, 2026. It is now read-only.

docs: change properties with function value to methods - #1047

Merged
steffnay merged 7 commits into
mainfrom
fhinkel-imports
Dec 4, 2021
Merged

steffnay merged 7 commits into
mainfrom
fhinkel-imports

Conversation

@fhinkel

@fhinkel fhinkel commented Nov 24, 2021 •

Copy link
Copy Markdown
Contributor

See microsoft/rushstack#3031

Internally, see b/206943288

Drive-by fix:

  • chore: change import format for better docs
  • Add description to BigQueryOptions properties

@fhinkel
fhinkel requested review from a team and tswast November 24, 2021 16:29
@google-cla google-cla Bot added the cla: yes This human has signed the Contributor License Agreement. label Nov 24, 2021
@product-auto-label product-auto-label Bot added the api: bigquery Issues related to the googleapis/nodejs-bigquery API. label Nov 24, 2021
@fhinkel fhinkel changed the title fhinkel imports docs: change properties with function value to methods Nov 24, 2021
@fhinkel
fhinkel force-pushed the fhinkel-imports branch 3 times, most recently from 7748635 to 31ca48a Compare November 24, 2021 18:33
@fhinkel
fhinkel force-pushed the fhinkel-imports branch 2 times, most recently from 4a448cf to e6955a4 Compare November 24, 2021 19:07
Comment thread src/bigquery.ts
* @param {?error} callback.err An error returned while making this request.
* @param {Job} callback.job The newly created job.
* @param {object} callback.apiResponse The full API response.
* @returns {Promise<JobResponse>}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I assume this was removed because it's now part of a type annotation?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Exactly.

Comment thread src/bigquery.ts
* A geography value represents a surface area on the Earth
* in Well-known Text (WKT) format.
*
* @method BigQuery.geography

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I assume this was removed because it's documented at the actual method definition now?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, it's redundant with TSDoc.

@steffnay
steffnay merged commit e3695ba into main Dec 4, 2021
@steffnay
steffnay deleted the fhinkel-imports branch December 4, 2021 18:21
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

api: bigquery Issues related to the googleapis/nodejs-bigquery API. cla: yes This human has signed the Contributor License Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants