On 04/28/2010 04:49 PM, Patrick Ohly wrote:
The advantage of .rst is that Emacs and other tools (GNOME)
the format. The disadvantage is that it might not always be recognized,
thus forcing to select a plain text reader.
Looks good to me, I don't think some additional "::" are a problem.
The other change that I made is to reorganize the content so that it
more like a reference man page. First, this minimizes the overlap with
instructions found elsewhere on syncevolution.org
. Second, it was an
incentive to document some aspects (environment variables!) which were
not documented before.
Attached is a copy. What do you think about these changes? Any spelling
mistakes, unclear statements, etc.?
I've read it through and it looks pretty good. I mean, it is really long
but for man page and README that makes sense: the subject matter is
complex and the text gives a thorough description as it should.
That said, I might not be the best evaluator for how thorough it is and
whether it has any unspoken "required knowledge", having worked on a
client for some time... If there's anyone on the list who is interested
in syncevolution and would like to contribute: Now is an excellent time,
previous experience not required: just read and comment.