although I can see the value of distinguishing a description vs readme file, I can also see that it's confusing enough to make me want the sample project to just have a readme for simplicity (and maybe just mention the distinction as a possibility)
I opened an issue here https://github.com/pypa/sampleproject/issues/31 I'd inclined to merge the change if someone posted a PR, or eventually get to it myself On Mon, Sep 28, 2015 at 8:18 AM, Chris Barker - NOAA Federal < chris.bar...@noaa.gov> wrote: > > > Sent from my iPhone > > On Sep 27, 2015, at 11:19 AM, Ionel Cristian Mărieș <cont...@ionelmc.ro> > wrote: > > > On Sun, Sep 27, 2015 at 8:05 PM, Thomas Güttler < > guettliml@thomas-guettler. <guettl...@thomas-guettler.de> > I don't think there can be a "definitive guide line". Unlike the core > language the packaging part of Python is a messy soup of different and > often competing ideas, styles and tools. > > > Which is EXACTLY why there should be one set of best-practices > recommendations that are the same in all the "official" docs. > > I think one Readme.rst is the way to go. > > If you want to provide contribution guidelines, etc. they should be in a > separate locations, referenced by the Readme. > > -Chris > > > > So you cannot have an definitive or objective guide for something that's > subjective in nature. > > About the README vs DESCRIPTION - ask yourself, what would you use README > for then? I believe that's absolutely nothing. You only need one. :-) > > > > Thanks, > -- Ionel Cristian Mărieș, http://blog.ionelmc.ro > > _______________________________________________ > Distutils-SIG maillist - Distutils-SIG@python.org > https://mail.python.org/mailman/listinfo/distutils-sig > > > _______________________________________________ > Distutils-SIG maillist - Distutils-SIG@python.org > https://mail.python.org/mailman/listinfo/distutils-sig > >
_______________________________________________ Distutils-SIG maillist - Distutils-SIG@python.org https://mail.python.org/mailman/listinfo/distutils-sig
