Skip to content

Document compatibility between gencode and runtime #121

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.

Sign up for GitHub

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

Open
anuraaga wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document compatibility between gencode and runtime #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,5 +172,6 @@ either major or minor versions.
- Dropping support for EOL Python versions can happen on minor version releases.
- Display and informational features such as formatting comment lines from a proto descriptor.

In addition, currently we only guarantee code generated by the same version of `protoc-gen-py` as `protobuf-py` will work.
This will be relaxed in the future.
Code generated by a version of `protoc-gen-py` will continue to work with any newer version of `protobuf-py`
within the same major version series, but may not work with older versions, e.g., code generated with 1.2
will work with 1.4, but may not work with 2.0 or 1.1.
5 changes: 5 additions & 0 deletions docs/getting-started/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,11 @@ The generated file is checked in to version control; re-run generation only when
Generated files should never be edited by hand.
They contain a `DO NOT EDIT` comment and will be overwritten on the next `buf generate`.

!!! note
Code generated with a version of `protoc-gen-py` will continue to work with any newer version of `protobuf-py`
within the same major version series, but may not work with older versions, e.g., code generated with 1.2
will work with 1.4, but may not work with 2.0 or 1.1.
Comment on lines +79 to +81

@timostamm timostamm Oct 1, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I don't think it's necessary to extend this note, but I was wondering about edge cases. WDYT about adding something more fleshed out to DESIGN.md? See #122


## Create messages

Import and instantiate the generated class using keyword arguments:
Expand Down
Loading