Add docs for derives

scalapb · Oct 17, 2023 · 3416943 · 3416943
1 parent ba25726
commit 3416943
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/docs/src/main/markdown/customizations.md b/docs/src/main/markdown/customizations.md
@@ -807,3 +807,22 @@ enum BarEnum {
   BarValue = 1 [(scalapb.enum_value).annotations = "@annotation4"];
 }
 ```
+
+## Adding derives clause
+
+In ScalaPB 0.11.14, it is possible to add a `derives` clause to generated messages and
+sealed oneofs:
+
+```protobuf
+message Foo {
+  option (scalapb.message).derives = "yourpkg.Show";
+  ...
+}}}
+
+message Expr {
+  option (scalapb.message).sealed_oneof_derives = "yourpkg.Show";
+  oneof sealed_value {
+    ...
+  }
+}
+```