Skip to content

Commit 855df6e

Browse files
committed
Make a note in the readme that the package definition is required.
1 parent d3d8267 commit 855df6e

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,10 @@ newLincoln = person_proto.Person()
8282
newLincoln.ParseFromString(serializedLincoln)
8383
```
8484

85+
The `package` definition is mandatory; it determines the Python module name that the code
86+
will generate. If it has dots for namespacing, like `com.cueup.foo`, the last part of the
87+
name (`foo`) will be used for the Python module name.
88+
8589
### One more thing
8690

8791
It's simple, but not that simple. The biggest caveat is that protobuf objects embedded in

0 commit comments

Comments
 (0)