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

Merge pull request #962 from apjanke/standard-american-english

Browse Source 
Standardize on American English for the Guide
This commit is contained in:
Marc Poulin
2018-12-20 15:09:18 -07:00
committed by GitHub
parent 9d975b5361 705e90ef43
commit 3ae73f4bb5
4 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/dev/env.rst
+1 -1
View File
@@ -252,7 +252,7 @@ pyenv
of the Python interpreter to be installed at the same time. This solves the of the Python interpreter to be installed at the same time. This solves the
problem of having different projects requiring different versions of Python. problem of having different projects requiring different versions of Python.
For example, it becomes very easy to install Python 2.7 for compatibility in For example, it becomes very easy to install Python 2.7 for compatibility in
one project, whilst still using Python 3.4 as the default interpreter. one project, while still using Python 3.4 as the default interpreter.
pyenv isn't just limited to the CPython versions – it will also install PyPy, pyenv isn't just limited to the CPython versions – it will also install PyPy,
Anaconda, miniconda, stackless, Jython, and IronPython interpreters. Anaconda, miniconda, stackless, Jython, and IronPython interpreters.
docs/intro/learning.rst
+2 -2
View File
@@ -151,7 +151,7 @@ Python Koans
~~~~~~~~~~~~ ~~~~~~~~~~~~
Python Koans is a port of Edgecase's Ruby Koans. It uses a test-driven 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 approach 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. test script, this provides sequential steps to learning Python.
@@ -179,7 +179,7 @@ no previous programming experience.
Learn to Program in Python with Codeacademy Learn to Program in Python with Codeacademy
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A Codeacademy course for the absolute Python beginner. This free and interactive course provides and teaches the basics (and beyond) of Python programming whilst testing the user's knowledge in between progress. A Codeacademy course for the absolute Python beginner. This free and interactive course provides and teaches the basics (and beyond) of Python programming while testing the user's knowledge in between progress.
This course also features a built-in interpreter for receiving instant feedback on your learning. This course also features a built-in interpreter for receiving instant feedback on your learning.
`Learn to Program in Python with Codeacademy <http://www.codecademy.com/en/tracks/python>`_ `Learn to Program in Python with Codeacademy <http://www.codecademy.com/en/tracks/python>`_
docs/notes/styleguide.rst
+2 -1
View File
@@ -84,6 +84,8 @@ Wrap text lines at 78 characters. Where necessary, lines may exceed 78
characters, especially if wrapping would make the source text more difficult characters, especially if wrapping would make the source text more difficult
to read. to read.
Use Standard American English, not British English.
Use of the `serial comma <https://en.wikipedia.org/wiki/Serial_comma>`_ Use of the `serial comma <https://en.wikipedia.org/wiki/Serial_comma>`_
(also known as the Oxford comma) is 100% non-optional. Any attempt to (also known as the Oxford comma) is 100% non-optional. Any attempt to
submit content with a missing serial comma will result in permanent banishment submit content with a missing serial comma will result in permanent banishment
@@ -209,4 +211,3 @@ documents or large incomplete sections.
.. todo:: .. todo::
Learn the Ultimate Answer to the Ultimate Question Learn the Ultimate Answer to the Ultimate Question
of Life, The Universe, and Everything of Life, The Universe, and Everything
docs/writing/documentation.rst
+1 -1
View File
@@ -182,7 +182,7 @@ comment block is a programmer's note. The docstring describes the
Unlike block comments, docstrings are built into the Python language itself. Unlike block comments, docstrings are built into the Python language itself.
This means you can use all of Python's powerful introspection capabilities to This means you can use all of Python's powerful introspection capabilities to
access docstrings at runtime, compared with comments which are optimised out. access docstrings at runtime, compared with comments which are optimized out.
Docstrings are accessible from both the `__doc__` dunder attribute for almost Docstrings are accessible from both the `__doc__` dunder attribute for almost
every Python object, as well as with the built in `help()` function. every Python object, as well as with the built in `help()` function.