feat(bigquery): add description for routine entities #9785
Conversation
googlebot
added
the
cla: yes
|
/cc @shollyman |
There was a problem hiding this comment.
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).
Edit: Hmm, it might be a local cache issue, let me re-check. (nope, it is indeed missing from the attributes summary)
| @@ -239,6 +240,17 @@ def body(self): | |||
| def body(self, value): | |||
| self._properties[self._PROPERTY_TO_API_FIELD["body"]] = value | |||
|
|
|||
| @property | |||
| def description(self): | |||
| """Union[str, None]: Description of the routine (defaults to | |||
There was a problem hiding this comment.
(nit)
Mypy docs recommend using the Optional shorthand instead of a Union with None.
| """Union[str, None]: Description of the routine (defaults to | |
| """Optional[str]: Description of the routine (defaults to |
There was a problem hiding this comment.
ohk, should i change same in the other files which has description property like in dataset.py and model.py .
There was a problem hiding this comment.
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. 👍
HemangChothani
deleted the
bigquery_add_description_for_routine_entities
branch
Fixes #9782