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

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

@tswast

Description

@tswast

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.

Metadata

Metadata

Assignees

Labels

api: docsIssues related to the Docs API API.priority: p3Desirable enhancement or fix. May not be included in next release.

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions