SKA-256: Extended and improved documentation

* Also: Fixed description in CLI help output Co-authored-by: Masse, Jean-Thomas <[email protected]>
vectorgrp · Jun 20, 2024 · 71d96cd · 71d96cd
1 parent b689fcb
commit 71d96cd
Show file tree

Hide file tree

Showing 2 changed files with 241 additions and 25 deletions.
diff --git a/FmuImporter/FmuImporter/Program.cs b/FmuImporter/FmuImporter/Program.cs
@@ -38,12 +38,14 @@ private static async Task Main(string[] args)
       "--fmu-importer-config-file",
       "Set the path to the FMU Importer configuration file.");
     fmuImporterConfigFileOption.AddAlias("-c");
+    fmuImporterConfigFileOption.ArgumentHelpName = "config-file";
     rootCommand.AddOption(fmuImporterConfigFileOption);
 
     var fmuImporterCommInterfaceFileOption = new Option<string?>(
       "--fmu-importer-communication-interface-file",
-      "Set the path to the FMU Importer configuration file.");
+      "Set the path to the FMU Importer communication interface file.");
     fmuImporterCommInterfaceFileOption.AddAlias("-i");
+    fmuImporterCommInterfaceFileOption.ArgumentHelpName = "communication-interface-file";
     rootCommand.AddOption(fmuImporterCommInterfaceFileOption);
 
     var participantNameOption = new Option<string>(