robot icon indicating copy to clipboard operation
robot copied to clipboard

`validate-profile` missing from `--help`

Open joeflack4 opened this issue 3 years ago • 4 comments

Summary

I am trying out robot validate-profile today, but I noticed that nothing about it appears in the help file:

usage: robot [command] [options] <arguments>
    --add-prefix <arg>      add prefix 'foo: http://bar' to the output
    --add-prefixes <arg>    add JSON-LD prefixes to the output
    --catalog <arg>         use catalog from provided file
 -h,--help                  print usage information
 -noprefixes                do not use default prefixes
 -p,--prefix <arg>          add a prefix 'foo: http://bar'
 -P,--prefixes <arg>        use prefixes from JSON-LD file
    --strict                use strict parsing when loading an ontology
 -V,--version               print version information
 -v,--verbose               increased logging
 -vv,--very-verbose         high logging
 -vvv,--very-very-verbose   maximum logging, including stack traces
 -x,--xml-entities          use entity substitution with ontology XML output

I'm using robot version 1.8.1.

joeflack4 avatar Jul 13 '22 19:07 joeflack4

This is what I see with ROBOT 1.8.1:

With robot --help (--help as an option flag) no commands are printed:

> robot --help
usage: robot [command] [options] <arguments>
    --add-prefix <arg>      add prefix 'foo: http://bar' to the output
    --add-prefixes <arg>    add JSON-LD prefixes to the output
    --catalog <arg>         use catalog from provided file
 -h,--help                  print usage information
 -noprefixes                do not use default prefixes
 -p,--prefix <arg>          add a prefix 'foo: http://bar'
 -P,--prefixes <arg>        use prefixes from JSON-LD file
    --strict                use strict parsing when loading an ontology
 -V,--version               print version information
 -v,--verbose               increased logging
 -vv,--very-verbose         high logging
 -vvv,--very-very-verbose   maximum logging, including stack traces
 -x,--xml-entities          use entity substitution with ontology XML
                            output

With robot help (help as a subcommand) I see all the commands:

> robot help
Connected to 192.168.2.70
usage: robot [command] [options] <arguments>
    --add-prefix <arg>      add prefix 'foo: http://bar' to the output
    --add-prefixes <arg>    add JSON-LD prefixes to the output
    --catalog <arg>         use catalog from provided file
 -h,--help                  print usage information
 -noprefixes                do not use default prefixes
 -p,--prefix <arg>          add a prefix 'foo: http://bar'
 -P,--prefixes <arg>        use prefixes from JSON-LD file
    --strict                use strict parsing when loading an ontology
 -V,--version               print version information
 -v,--verbose               increased logging
 -vv,--very-verbose         high logging
 -vvv,--very-very-verbose   maximum logging, including stack traces
 -x,--xml-entities          use entity substitution with ontology XML
                            output
commands:
 help             print help for command
 annotate         annotate ontology
 collapse         minimize an ontology based on a threshold
 convert          convert ontology
 diff             find the differences between two ontologies
 explain          explain derivation of an inferred axiom
 export           export ontology as a table
 export-prefixes  export prefixes to a file
 extract          extract terms from an ontology
 filter           filter ontology axioms
 materialize      materialize ontology
 merge            merge ontologies
 measure          compute the metrics of an ontology
 mirror           mirror ontology imports closure
 python           start a server to run ROBOT with Py4J
 query            query an ontology
 reason           reason ontology
 reduce           reduce ontology
 relax            relax ontology
 remove           remove axioms from an ontology
 rename           rename entities based on given mappings
 repair           repair terms from an ontology
 report           report terms from an ontology
 template         build an ontology from a template
 unmerge          unmerge ontologies
 validate-profile validate ontology against an OWL profile
 verify           verify an ontology does not violate rules (as queries)

I don't remember the reason for this distinction, but it seems OK to me.

Is that what you're seeing?

jamesaoverton avatar Jul 28 '22 16:07 jamesaoverton

Yeah, I see that.

Haven't seen two ways to access a CLI help file before. Maybe this is common and I've just never tried.

I'd still consider this an issue; just less severe now than before. Indeed, I wonder why the difference.

joeflack4 avatar Jul 28 '22 18:07 joeflack4

robot validate-profile --help

Prints help specific to validate-profile:

usage: robot validate-profile --profile <profile> --output <file>
    --add-prefix <arg>      add prefix 'foo: http://bar' to the output
    --add-prefixes <arg>    add JSON-LD prefixes to the output
    --catalog <arg>         use catalog from provided file
 -h,--help                  print usage information
 -i,--input <arg>           validate ontology from a file
 -I,--input-iri <arg>       validate ontology from an IRI
    --noprefixes            do not use default prefixes
 -o,--output <arg>          save validation report to a file
 -p,--profile <arg>         OWL profile to validate (DL, EL, RL, QL, or
                            Full)
 -P,--prefixes <arg>        use prefixes from JSON-LD file
    --strict                use strict parsing when loading an ontology
 -V,--version               print version information
 -v,--verbose               increased logging
 -vv,--very-verbose         high logging
 -vvv,--very-very-verbose   maximum logging, including stack traces
 -x,--xml-entities          use entity substitution with ontology XML
                            output

This seems like more what you want?

matentzn avatar Jul 31 '22 09:07 matentzn

@matentzn I'm not sure if this is directed at me. I do know about the existence of the help text for validate-profile. But when I mean that it is missing from --help, I mean that it is missing from the "front page" (robot --help).

@jamesaoverton @matentzn I can't think of a good reason for robot help and robot --help not displaying identical text. I think it merits at least opening a low priority issue. If you want I can do that; up to you guys.

joeflack4 avatar Aug 01 '22 20:08 joeflack4