Skip to content

Commit 7bb33ae

Browse files
committed
Link to the protobuf generated code guide
Signed-off-by: Nic Cope <[email protected]>
1 parent e247d87 commit 7bb33ae

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,13 @@ guidelines] as Crossplane.
1010
To learn how to use this SDK:
1111

1212
* [Learn about how composition functions work][functions]
13+
* [Learn about Python code generated from protocol buffers][python-protobuf]
14+
15+
The `RunFunctionRequest` and `RunFunctionResponse` types provided by this SDK
16+
are generated from a proto3 protocol buffer schema. Their fields behave
17+
similarly to built-in Python types like lists and dictionaries, but there are
18+
some differences. Read the generated code documentation to familiarize yourself
19+
with the the differences.
1320

1421
## Contributing
1522

@@ -35,5 +42,6 @@ hatch build
3542

3643
[python]: https://python.org
3744
[functions]: https://docs.crossplane.io/latest/concepts/composition-functions
45+
[python-protobuf]: https://protobuf.dev/reference/python/python-generated/
3846
[contributing guidelines]: https://github.com/crossplane/crossplane/tree/master/contributing
3947
[hatch]: https://github.com/pypa/hatch

0 commit comments

Comments
 (0)