Re: [Zope3-dev] Re: [StabilizeEggPackages] (edit) Is that all that has to be done in setup.py?
Am Mittwoch, den 29.08.2007, 09:58 -0400 schrieb Fred Drake: On 8/29/07, srichter [EMAIL PROTECTED] wrote: ++added: - Ensure that the setup.py has a decent set of meta-data, in particular: * The long_description contains all doctests. I know Jim's advocated this, at least for all documentation-centric doctests, but I don't know that we've reached a consensus on this. What do others think? I really don't like long PyPI pages myself; a few paragraphs seems sufficient, and is certainly more in line with the original intent of the long description field. IMHO This issue doesn't have to be dealt with for the initial stable release. My highest interest is getting the stable software out of the door in a timely manner. The more we add to the TODO list for each package the longer it's going to take. Christian ___ Zope3-dev mailing list Zope3-dev@zope.org Unsub: http://mail.zope.org/mailman/options/zope3-dev/archive%40mail-archive.com
Re: [Zope3-dev] Re: [StabilizeEggPackages] (edit) Is that all that has to be done in setup.py?
Previously Fred Drake wrote: On 8/29/07, srichter [EMAIL PROTECTED] wrote: ++added: - Ensure that the setup.py has a decent set of meta-data, in particular: * The long_description contains all doctests. I know Jim's advocated this, at least for all documentation-centric doctests, but I don't know that we've reached a consensus on this. What do others think? I really don't like long PyPI pages myself; a few paragraphs seems sufficient, and is certainly more in line with the original intent of the long description field. I don't like the overly long PyPI pages, but I do really like having easily browsable documentation online. PyPI is the only places where that is possible at the moment. Pointing people to svn.zope.org to read documentation is not an option in my opinion: finding and reading documentation would require a dozen extra mouseclicks. Wichert. -- Wichert Akkerman [EMAIL PROTECTED]It is simple to make things. http://www.wiggy.net/ It is hard to make things simple. ___ Zope3-dev mailing list Zope3-dev@zope.org Unsub: http://mail.zope.org/mailman/options/zope3-dev/archive%40mail-archive.com
Re: [Zope3-dev] Re: [StabilizeEggPackages] (edit) Is that all that has to be done in setup.py?
I have been following this approach with the long descriptions for my package descriptions and believe it it a consistent and meaningful way of communicating to a developer. It is not enough for me to see a couple of paragraphs. The doctest text inclusion gives me an immediate answer to what the package is about and how it works. I like what has been done very much and would like it to continue this way. Many thanks. Regards, David Benji York wrote: Christian Theune wrote: Am Mittwoch, den 29.08.2007, 09:58 -0400 schrieb Fred Drake: I really don't like long PyPI pages myself; a few paragraphs seems sufficient, and is certainly more in line with the original intent of the long description field. Since you asked: I like it (in absence of better project web pages). IMHO This issue doesn't have to be dealt with for the initial stable release. My highest interest is getting the stable software out of the door in a timely manner. The more we add to the TODO list for each package the longer it's going to take. +1 ___ Zope3-dev mailing list Zope3-dev@zope.org Unsub: http://mail.zope.org/mailman/options/zope3-dev/archive%40mail-archive.com
Re: [Zope3-dev] Re: [StabilizeEggPackages] (edit) Is that all that has to be done in setup.py?
On 8/29/07, Wichert Akkerman [EMAIL PROTECTED] wrote: I don't like the overly long PyPI pages, but I do really like having easily browsable documentation online. PyPI is the only places where that is possible at the moment. In the absence of something better, yes, it's better than nothing at all. I'm not proposing ripping it out for packages that already do that. I'm simply suggesting that perhaps it shouldn't be a requirement for moving forward. Pointing people to svn.zope.org to read documentation is not an option in my opinion: finding and reading documentation would require a dozen extra mouseclicks. I certainly agree that pointing to Subversion for documentation is painful at best, and doesn't provide a reasonable experience. -Fred -- Fred L. Drake, Jr.fdrake at gmail.com Chaos is the score upon which reality is written. --Henry Miller ___ Zope3-dev mailing list Zope3-dev@zope.org Unsub: http://mail.zope.org/mailman/options/zope3-dev/archive%40mail-archive.com
Re: [Zope3-dev] Re: [StabilizeEggPackages] (edit) Is that all that has to be done in setup.py?
--On 29. August 2007 16:15:36 +0200 Wichert Akkerman [EMAIL PROTECTED] wrote: I don't like the overly long PyPI pages, but I do really like having easily browsable documentation online. PyPI is the only places where that is possible at the moment. Pointing people to svn.zope.org to read documentation is not an option in my opinion: finding and reading documentation would require a dozen extra mouseclicks. I also prefer the overlong Pypi pages as long as there is no chance to jump _directly_ from PyPI into the related documentation section. Clicking on some svn.zope.org link and clicking through the directory structure is not a very option from the usability prospective (even for experienced programmers). Andreas pgpcga52BvtBd.pgp Description: PGP signature ___ Zope3-dev mailing list Zope3-dev@zope.org Unsub: http://mail.zope.org/mailman/options/zope3-dev/archive%40mail-archive.com
