search

meshy / pythonwheels

Adoption analysis of Python Wheels: https://pythonwheels.com/
BSD 2-Clause "Simplified" License
102 stars 26 forks source link

Improve documentation #33

Closed LilyFoote closed 10 years ago

LilyFoote commented 10 years ago

Add Advantages of wheels and Other Resources sections. Split information about creating wheels into Pure Python and C extensions subsections. Add link to pull-requests on github to encourage more active participation.

I have tried to cover the suggestions made in issue #29 by @zzzeek. I have also included suggestions from #22 and #16.

ncoghlan commented 10 years ago

Looks good to me - thanks for putting this together!

meshy commented 10 years ago

This all looks great, @Ian-Foote. Thank-you very much for putting so much effort into this.

If it's ok, I would like to ask you to make one change before I merge. Would it be possible to include the link to the "authoritative resource" even more prominently? Specifically, if it could be moved to the bottom of the "What is this list" section, that would be amazing. I'm thinking that the copy should make it absolutely clear that pythonwheels.com is not the official website for python wheels by saying something like:

This is not the official website for wheels, just a nice visual way to measure adoption. To see the authoritative guide, see the Python Packaging User Guide.

Thank-you! Charlie.

LilyFoote commented 10 years ago

@meshy I'm happy to do that if the Python Packaging User Guide is considered sufficiently ready. @qwcode Thoughts?

ncoghlan commented 10 years ago

Yeah, PPUG is already the best available resource - the CPython docs link to it from the disclaimers at the top of the distribution, installation and extension building guides.

It also has a a nice new URL at http://packaging.python.org (although the old URL still works)

meshy commented 10 years ago

Great stuff! Thanks!