Hello!
For SyncEvolution 1.0 we already revamped the documentation and added a
man page, all generated from the same README.rst. The output of
"syncevolution --help" was the last duplicated piece of documentation
material.
I have experimented with removing that duplication. The result is on the
pohly branch. I'd like to get some feedback on the approach taken:
* README.rst contains SYNOPSIS, USAGE, OPTIONS.
* SYNOPSIS introduces the command line syntax.
* USAGE introduces features most operations.
* OPTIONS then adds a more formal definition of the command line
parameters.
* The SYNOPSIS and OPTIONS part appear again in the --help output.
I had some problems fitting --restore into that concept. Does the
current state make sense? Suggestions for improvements?
Current README.rst and --help output are attached.
--
Best Regards, Patrick Ohly
The content of this message is my personal opinion only and although
I am an employee of Intel, the statements I make here in no way
represent Intel's position on the issue, nor am I authorized to speak
on behalf of Intel on this matter.
Show replies by date