docs(ref): Be more explicit with ArgEnums

clap-rs · Apr 30, 2022 · d411e7a · d411e7a
1 parent 0a1cfe3
commit d411e7a
Showing 1 changed file with 7 additions and 4 deletions.
diff --git a/examples/derive_ref/README.md b/examples/derive_ref/README.md
@@ -28,7 +28,10 @@ use clap::{Parser, Args, Subcommand, ArgEnum};
 struct Cli {
     /// Doc comment
     #[clap(ARG ATTRIBUTE)]
-    field: Type,
+    field: UserType,
+
+    #[clap(arg_enum, ARG ATTRIBUTE...)]
+    field: EnumValues,
 
     #[clap(flatten)]
     delegate: Struct,
@@ -43,7 +46,7 @@ struct Cli {
 struct Struct { 
     /// Doc comment
     #[clap(ARG ATTRIBUTE)]
-    field: Type,
+    field: UserType,
 }
 
 /// Doc comment
@@ -59,14 +62,14 @@ enum Command {
     Variant2 {
         /// Doc comment
         #[clap(ARG ATTRIBUTE)]
-        field: Type,
+        field: UserType,
     }
 }
 
 /// Doc comment
 #[derive(ArgEnum)]
 #[clap(ARG ENUM ATTRIBUTE)]
-enum Mode {
+enum EnumValues {
     /// Doc comment
     #[clap(POSSIBLE VALUE ATTRIBUTE)]
     Variant1,