Work on documentation

ecmwf · May 28, 2024 · f5f901e · f5f901e
1 parent 83a1a21
commit f5f901e
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/src/anemoi/inference/commands/metadata.py b/src/anemoi/inference/commands/metadata.py
@@ -32,7 +32,9 @@ def add_arguments(self, command_parser):
         command_parser.add_argument("path", help="Path to the checkpoint.")
 
         group = command_parser.add_mutually_exclusive_group(required=True)
-        group.add_argument("--edit", action="store_true", help="Edit metadata.")
+        group.add_argument(
+            "--edit", action="store_true", help="Edit the metadata in place, using the specified editor."
+        )
         group.add_argument("--remove", action="store_true", help="Remove metadata.")
         group.add_argument(
             "--dump",
@@ -56,7 +58,11 @@ def add_arguments(self, command_parser):
 
         command_parser.add_argument("--input", help="The output file name to be used by the ``--load`` option.")
         command_parser.add_argument("--output", help="The output file name to be used by the ``--dump`` option.")
-        command_parser.add_argument("--editor", help="Editor to use.", default=os.environ.get("EDITOR", "vi"))
+        command_parser.add_argument(
+            "--editor",
+            help="Editor to use for the ``--edit`` option. Default to ``$EDITOR`` if defined, else ``vi``.",
+            default=os.environ.get("EDITOR", "vi"),
+        )
         command_parser.add_argument("--json", action="store_true", help="Output in JSON format.")
         command_parser.add_argument("--yaml", action="store_true", help="Output in YAML format.")