kennethreitz/python-guide
1
0
Fork 0
mirror of https://github.com/kennethreitz/python-guide.git synced 2026-06-05 23:00:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Use the :pep: tag instead of directly linking PEPs

Browse Source
This commit is contained in:
kuyan
2013-07-30 13:05:56 -07:00
parent cbcbce56c8
commit b6f014342d
10 changed files with 25 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/intro/community.rst
+4 -4
View File
@@ -27,7 +27,7 @@ PEPs
PEPs are *Python Enhancement Proposals*. They describe changes to Python itself,
or the standards around it.
There are three different types of PEPs (as defined by `PEP1 <http://www.python.org/dev/peps/pep-0001/>`_):
There are three different types of PEPs (as defined by :pep:`1`):
**Standards**
Describes a new feature or implementation.
@@ -45,13 +45,13 @@ Notable PEPs
There are a few PEPs that could be considered required reading:
- `PEP8 <http://www.python.org/dev/peps/pep-0008/>`_: The Python Style Guide.
- :pep:`8`: The Python Style Guide.
Read this. All of it. Follow it.
- `PEP20 <http://www.python.org/dev/peps/pep-0020/>`_: The Zen of Python.
- :pep:`20`: The Zen of Python.
A list of 19 statements that briefly explain the philosophy behind Python.
- `PEP257 <http://www.python.org/dev/peps/pep-0257/>`_: Docstring Conventions.
- :pep:`257`: Docstring Conventions.
Gives guidelines for semantics and conventions associated with Python
docstrings.
docs/intro/learning.rst
+2 -2
View File
@@ -65,7 +65,7 @@ Python Koans
Python Koans is a port of Edgecase's Ruby Koans. It uses a test-driven
approach, q.v. TEST DRIVEN DESIGN SECTION to provide an interactive tutorial
teaching basic python concepts. By fixing assertion statements that fail in a
teaching basic python concepts. By fixing assertion statements that fail in a
test script, this provides sequential steps to learning python.
For those used to languages and figuring out puzzles on their own, this can be
@@ -105,7 +105,7 @@ is focused on the more advanced crowd.
It starts with topics like decorators (with caching, proxy, and context manager
case-studies), method resolution order, using super() and meta-programming, and
general PEP8 best practices.
general :pep:`8` best practices.
It has a detailed, multi-chapter case study on writing and releasing a package
and eventually an application, including a chapter on using zc.buildout. Later