Skip to content

Link concrete entry classes into usage docs - #5512

Merged
tseaver merged 1 commit into
googleapis:masterfrom
tseaver:4118-logging-usage_link_entry_api_ref
Jun 21, 2018
Merged

tseaver merged 1 commit into
googleapis:masterfrom
tseaver:4118-logging-usage_link_entry_api_ref

Conversation

@tseaver

@tseaver tseaver commented Jun 20, 2018 •

Copy link
Copy Markdown
Contributor

Closes #4118.

Note that those API docs won't be as useful as they could be without either making _BaseEntry public (see #5511) or going to extra effort to propagate the signature docs for __init__.

Closes #4118.

Note that those API docs won't be as useful as they could be without
either making '_BaseEntry' public (see #5511) or going to extra effort
to propagate the signature docs for '__init__'.
@tseaver tseaver added api: logging Issues related to the Cloud Logging API. type: docs Improvement to the documentation for an API. labels Jun 20, 2018
@tseaver
tseaver requested review from theacodes and tswast June 20, 2018 19:26
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Jun 20, 2018

@tswast tswast 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.

In BigQuery we have a similar situation, and we use a Union type rather than referring to the base class. See: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/2252253325826ecf5b769a33d9d70b6427754d1c/bigquery/google/cloud/bigquery/client.py#L606-L609

@tseaver
tseaver merged commit 0503ee7 into googleapis:master Jun 21, 2018
@tseaver
tseaver deleted the 4118-logging-usage_link_entry_api_ref branch June 21, 2018 01:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: logging Issues related to the Cloud Logging API. cla: yes This human has signed the Contributor License Agreement. type: docs Improvement to the documentation for an API.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants