Skip to content

feat(bigquery): add description for routine entities - #9785

Merged
tswast merged 2 commits into
googleapis:masterfrom
MaxxleLLC:bigquery_add_description_for_routine_entities
Nov 19, 2019
Merged

feat(bigquery): add description for routine entities#9785
tswast merged 2 commits into
googleapis:masterfrom
MaxxleLLC:bigquery_add_description_for_routine_entities

Conversation

@HemangChothani

Copy link
Copy Markdown
Contributor

Fixes#9782

@HemangChothani
HemangChothani requested review from a team, plamut and tswastNovember 13, 2019 14:07
@googlebotgooglebot added the cla: yes This human has signed the Contributor License Agreement. label Nov 13, 2019
@tseaver

Copy link
Copy Markdown
Contributor

/cc @shollyman

@plamutplamut left a comment

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.

UPDATE: Nah, sorry, it does seem to work. I had to delete docs/generated directory as well (and not just docs/_build)


It seems that the description property is present in the generated docs, but in not the attributes summary table (unlike other Routine attributes).

Screenshot from 2019-11-14 09-41-15

Edit:Hmm, it might be a local cache issue, let me re-check. (nope, it is indeed missing from the attributes summary)


@property
def description(self):
"""Union[str, None]: Description of the routine (defaults to

@plamutplamutNov 14, 2019

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.

(nit)
Mypy docs recommend using the Optional shorthand instead of a Union with None.

Suggested change
"""Union[str, None]: Descriptionoftheroutine (defaultsto
"""Optional[str]: Descriptionoftheroutine (defaultsto

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

ohk, should i change same in the other files which has description property like in dataset.py and model.py .

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.

Strictly speaking it is not in scope of this PR, but if it's not too much work, it would be a welcome cleanup IMO. 👍

@plamutplamut left a comment

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.

LGTM.

There are still usages of Union[foo, None], but with other attributes, thus let's leave that out for another time.

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

Labels

cla: yesThis human has signed the Contributor License Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BigQuery: add Description for Routine entities

5 participants

@HemangChothani@tseaver@tswast@plamut@googlebot