WARNING: This server is unstable and will be retired in the next days. If you want to keep this forum available, please request immediately a migration on the Nabble Support forum. Forums that don't receive any migration request will be deleted forever.

Philosophical wishlist.

View: New views
2 Messages — Rating Filter:   Alert me  

Philosophical wishlist.

by Kjetil Halvorsen :: Rate this Message:

| View Threaded | Show Only this Message

 All the GNU coreutils commands should accept a new flag:
 --example

 Which should print a (half) screenfull of instructive examples,
 functioning as a reminder.

 This idea is taken from the project Gnu R (www.r-project.org).
 R has a command example, which is invoked as
 example(fun)

 and then runs the examples from the help-page of fun.

 Extremely usefull!

Kjetil Brinchmann Halvorsen


Re: Philosophical wishlist.

by Karl Berry :: Rate this Message:

| View Threaded | Show Only this Message

Hi Kjetil,

     All the GNU coreutils commands should accept a new flag:
     --example

I fully agree with you about the importance of showing examples.
However, I don't think a new option common to all programs is the thing
to do -- the overhead involved is unbelievable.

Instead, I think programs should add the info to their --help messages.
That also has the benefits of (a) not forcing users to hear about a new
option, and (b) allowing easy re-use of the examples in man pages
generated by help2man, as they are in coreutils.

So my suggestion is to write to bug-coreutils (or wherever else).
My guess is the answer will be "patches are welcome" :).

Meanwhile, I'll put something about it in the coding standards, so
maintainers might at least be more likely to think about it.

Thanks,
Karl