[Zope3-checkins] Re: [Checkins] SVN: z3c.metrics/trunk/ Initial import

[Ross Patterson]

Stephan Richter <srichter at cosmos.phy.tufts.edu> writes:

> On Wednesday 16 April 2008, Ross Patterson wrote:
>> Log message for revision 85434:
>>   Initial import
>
> Hi Ross, I think your documentation lacks a lot of motivation. I have
> no idea what the package is about.

Well it is in development, better documentation is on my todo list prior
to a release.  :)

Did you read any of the package documentation?  Are there any
conventions or style guides available for better conveying motivation?
Is your comment more generally about all my packages, not just this one?

If your comment is also in response to z3c.persistentfactory, I'm in the
middle of a stop and start conversation with Martin Aspeli trying to
improve it's documentation.  So any more specific guidance for how to
write better documentation would be much appreciated?

Is it inappropriate to use the svn.zope.org repository before end-user
documentation is ready?  Are there any conventions and style guides for
commit messages I should be aware of?

I'd definitely like to learn how to better promote my code.  Can you
clarify your criticisim here so I can better make use of it?

Ross