search

dart-lang / core

This repository is home to core Dart packages.
https://pub.dev/publishers/dart.dev
BSD 3-Clause "New" or "Revised" License
19 stars 7 forks source link

Display a description and a quick usage message #62

Open PoloLacoste opened 3 years ago

PoloLacoste commented 3 years ago

Would it be usefull to add a quick usage message and a description at the top of the usage message.

For instance, the example in 'example/test_runner.dart' would look like this :

usage: [-c] [-r] [-a] [-s] [-m] [--[no-]checked] [--[no-]host-checked] [-t] [-j] [--shards] [--shard] [--[no-]valgrind] [-p] [--[no-]report] [-v] [--[no-]list] [--[no-]time] [-b] [--[no-]keep-generated-tests] [--special-command] [--dart] [--drt] [--dartium] [--mandatory]

A simple description

===== Platform
-c, --compiler                     Specify any compilation step (if needed).
[...]
munificent commented 3 years ago

I think most users simply print the description themselves before printing the usage information:

A simple description

usage: [-c] [-r] [-a] [-s] [-m] [--[no-]checked] [--[no-]host-checked] [-t] [-j] [--shards] [--shard] [--[no-]valgrind] [-p] [--[no-]report] [-v] [--[no-]list] [--[no-]time] [-b] [--[no-]keep-generated-tests] [--special-command] [--dart] [--drt] [--dartium] [--mandatory]

===== Platform
-c, --compiler                     Specify any compilation step (if needed).
[...]