[Python-ideas] PEP links in docs

Georg Brandl g.brandl at gmx.net
Mon Mar 16 22:56:24 CET 2009


Feel free to send patches, as small as they may seem.  Mark up PEP numbers
in reST like this -- :pep:`42` -- to get automatic linking.

Georg

Shawn Ligocki schrieb:
> +2, Sign me up.
> 
> The "why" is the most annoyingly avoided question in teaching anything.
> 
> If someone leads this, I'll help contribute!
> 
> Cheers,
> 
> Shawn Ligocki
> sligocki at gmail.com
> <mailto:sligocki at gmail.com>
> 
> On Mon, Mar 16, 2009 at 10:25 AM, Zac Burns
> <zac256 at gmail.com
> <mailto:zac256 at gmail.com>> wrote:
> 
>     I would like to see links to relevant PEP / mailing list docs in the
>     main docs.
> 
>     For example http://docs.python.org/library/dircache.html after
>     "Deprecated since version 2.6" could include a (PEP x.x) link where I
>     could read why it was deprecated and probably what to use in it's
>     place.
> 
>     The docs right now are quite excellent describing the "what" about
>     everything, but often have little to say about the "why". This is a
>     good thing, but links would surely help those that want to learn more.
> 
>     --
>     Zachary Burns
>     (407)590-4814
>     Aim - Zac256FL
>     Production Engineer (Digital Overlord)
>     Zindagi Games
>     _______________________________________________
>     Python-ideas mailing list
>     Python-ideas at python.org
>     <mailto:Python-ideas at python.org>
>     http://mail.python.org/mailman/listinfo/python-ideas
> 
> 
> 
> ------------------------------------------------------------------------
> 
> _______________________________________________
> Python-ideas mailing list
> Python-ideas at python.org
> http://mail.python.org/mailman/listinfo/python-ideas


-- 
Thus spake the Lord: Thou shalt indent with four spaces. No more, no less.
Four shall be the number of spaces thou shalt indent, and the number of thy
indenting shall be four. Eight shalt thou not indent, nor either indent thou
two, excepting that thou then proceed to four. Tabs are right out.




More information about the Python-ideas mailing list