Skip to content
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.

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

docs: not clear that generated types have serialize / deserialize methods #685

Closed
tswast opened this issue Oct 27, 2020 · 5 comments
Closed
Assignees
Labels
api: docs Issues related to the Docs API API. priority: p3 Desirable enhancement or fix. May not be included in next release.

Comments

@tswast
Copy link

tswast commented Oct 27, 2020

I had a customer that was pickling protobuf objects because they didn't know they could serialize / deserialize the protocol buffer objects. (internal issue 171748167)

If you browse the documentation at https://googleapis.dev/python/bigquerystorage/latest/bigquery_storage_v1/types.html there is no indication that this is possible.

Suggestion 1

Show that these objects are inherited from proto-plus message objects and use intersphinx to ensure they get a clickable link to the Message reference docs https://proto-plus-python.readthedocs.io/en/latest/reference/message.html#proto.message.Message

Suggestion 2

Add :show-inheritance: and :inherited-members: to the types.rst file.

@product-auto-label product-auto-label bot added the api: docs Issues related to the Docs API API. label Oct 27, 2020
@tswast
Copy link
Author

tswast commented Oct 27, 2020

Possibly fixed by #680 ? Looks like I haven't merged that change into bigquery-storage yet.

@yoshi-automation yoshi-automation added triage me I really want to be triaged. 🚨 This issue needs some love. labels Oct 29, 2020
@software-dov software-dov added priority: p3 Desirable enhancement or fix. May not be included in next release. and removed triage me I really want to be triaged. labels Nov 4, 2020
@software-dov
Copy link
Contributor

What's the consensus on whether this is fixed by #680 ?

@yoshi-automation yoshi-automation removed the 🚨 This issue needs some love. label Nov 4, 2020
@tswast
Copy link
Author

tswast commented Nov 4, 2020

I haven't cut a release yet since googleapis/python-bigquery-storage#91 and googleapis/python-bigquery-storage#86 so I'm not sure if it's enough. Should be an improvement at least, though.

@software-dov
Copy link
Contributor

Moving to close since the change has been made in the generator.

@tswast
Copy link
Author

tswast commented Nov 4, 2020

Thanks, just cut a release. https://googleapis.dev/python/bigquerystorage/latest/bigquery_storage_v1/types.html looks pretty good to me. Hopefully customers click on that base class link.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: docs Issues related to the Docs API API. priority: p3 Desirable enhancement or fix. May not be included in next release.
Projects
None yet
Development

No branches or pull requests

3 participants