Quellcode durchsuchen

Add a simple warning about the prefix option.

Thomas Van Lenten vor 8 Jahren
Ursprung
Commit
e151ca9ee3
1 geänderte Dateien mit 5 neuen und 0 gelöschten Zeilen
  1. 5 0
      Documentation/API.md

+ 5 - 0
Documentation/API.md

@@ -130,6 +130,11 @@ in your proto file:
 will generate a struct named `MyFooBar`.
 (Note: `swift_prefix` is only supported by protoc 3.2 or later.)
 
+:warning: The `swift_prefix` option has proven problematic in practice.
+Because it ignores the `package` directive, it can easily lead to name
+conflicts and other confusion as your shared proto definitions evolve over
+time.
+
 If the resulting name would collide with a Swift reserved word
 or would otherwise cause problems in the generated code,
 then the word `Message` is appended to the name.