[Zope3-dev] Re: SVN: zope.location/trunk/setup.py using pypi as homepage instead of svn.zope.org

Wichert Akkerman wichert at wiggy.net
Tue Aug 21 02:34:58 EDT 2007


Previously Stephan Richter wrote:
> On Saturday 18 August 2007 17:03, Philipp von Weitershausen wrote:
> > * Please also don't forget to add a changelog entry in README.txt,
> > especially if you're adding features. If there's no README.txt yet, this
> > is a good time to give it one. It should start out with a simple
> > paragraph and have at least one section called "Changes". You could then
> > use its contents as the long_description in setup.py. Other packages
> > (e.g. zope.proxy or zope.publisher) can serve as examples.
> 
> Why do the changes have to be part of the README file? That seems no good. I 
> think a separate file is much better.

+1

The audience for changelog information is different than the audience
for normal documentation.

If you really want to you can combine both files in the long_description
from your setup.py. That can make your cheesehop package page overly
large though.

Wichert.

-- 
Wichert Akkerman <wichert at wiggy.net>    It is simple to make things.
http://www.wiggy.net/                   It is hard to make things simple.


More information about the Zope3-dev mailing list