nfdi4plants / ARCCommander

Tool to manage your ARCs
MIT License
11 stars 9 forks source link

modified CLI arguments help in IArgParserTemplate #231

Closed cmohl2013 closed 8 months ago

cmohl2013 commented 8 months ago

Modification of docstrings.

When registering protocols with ARCCommander I had a hard time to find out, that e.g. ParametersTermAccssionNumber has to be set as a semicolon delimited list of the same lengths as ParametersName.

I therefore propose the following modifications of the CLI help.

Best regards Christoph

The error message could also be a bit more specific:

Start Protocol Register 
Done processing command. 
ERROR: System.Exception: The length of the aggregated string tt does not match the length of the others System.Exception: The length of the aggregated string tt does not match the length of the others
   at Microsoft.FSharp.Core.PrintfModule.PrintFormatToStringThenFail@1448.Invoke(String message)
   at Microsoft.FSharp.Collections.ArrayModule.Fold[T,TState](FSharpFunc`2 folder, TState state, T[] array) in D:\a\_work\1\s\src\FSharp.Core\array.fs:line 1351
   at ISADotNet.XLSX.Component.fromAggregatedStrings(Char separator, String names, String terms, String source, String accessions)
   at ISADotNet.XLSX.Protocols.fromString(String name, String protocolType, String typeTermAccessionNumber, String typeTermSourceREF, String description, String uri, String version, String parametersName, String parametersTermAccessionNumber, String parametersTermSourceREF, String componentsName, String componentsType, String componentsTypeTermAccessionNumber, String componentsTypeTermSourceREF, FSharpList`1 comments)
   at ArcCommander.APIs.StudyAPI.Protocols.register(ArcConfiguration arcConfiguration, FSharpMap`2 protocolArgs)
   at ArcCommander.Program.handleStudyProtocolSubCommands@118-2.Invoke(ArcConfiguration arcConfiguration, FSharpMap`2 protocolArgs)
   at ArcCommander.Program.processCommand[a,T](ArcConfiguration arcConfiguration, FSharpFunc`2 commandF, ParseResults`1 r)
   at ArcCommander.Program.handleStudyProtocolSubCommands(ArcConfiguration arcConfiguration, StudyProtocolCommand protocolVerb)
   at ArcCommander.Program.handleStudySubCommands(ArcConfiguration arcConfiguration, StudyCommand studyVerb)
   at ArcCommander.Program.handleCommand(ArcConfiguration arcConfiguration, ArcCommand command)
   at ArcCommander.Program.main(String[] argv)