Skip to content

Commit 8483ae3

Browse files
author
Kenneth Reitz
committed
Merge pull request realpython#258 from rgbkrk/master
Tiny bit of grammar fixes and plenty of spacing fixes
2 parents 581284d + 7a1077a commit 8483ae3

File tree

9 files changed

+644
-645
lines changed

9 files changed

+644
-645
lines changed

Readme.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,13 @@ Hitchhiker's Guide to Python
55

66
-----------
77

8-
**Work in progress. If you'd like to help, please do. There's a lot of work to be done.**
8+
**Work in progress. If you'd like to help, please do. There's a lot of work to
9+
be done.**
910

10-
This guide is currently under heavy development. This opinionated guide exists to provide both novice and expert Python developers a best-practice handbook to the installation, configuration, and usage of Python on a daily basis.
11+
This guide is currently under heavy development. This opinionated guide
12+
exists to provide both novice and expert Python developers a best-practice
13+
handbook to the installation, configuration, and usage of Python on a daily
14+
basis.
1115

1216

1317
Topics include:

docs/dev/env.rst

Lines changed: 19 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -64,21 +64,17 @@ to do that which also shows status and warning messages in the statusbar would b
6464
Python-mode
6565
^^^^^^^^^^^
6666

67-
Python-mode_ is complex solution in VIM for work with python code.
67+
Python-mode_ is a complex solution in VIM for working with python code.
6868
It has:
6969

70-
- Async python code checking (pylint, pyflakes, pep8, mccabe) in any combination;
71-
- Code refactoring and autocompletion with Rope;
72-
- Fastest python folding;
73-
- Nice and powered python syntax;
74-
- Virtual env support;
75-
- Search by python documentation and run python code;
76-
- More other things like auto pep8 error fixes;
77-
- Very customizable and documented as well;
78-
- Have all required libraries in self;
79-
80-
And more stuff.
70+
- Async python code checking (pylint, pyflakes, pep8, mccabe) in any combination
71+
- Code refactoring and autocompletion with Rope
72+
- Fast python folding
73+
- Virtualenv support
74+
- Search by python documentation and run python code
75+
- Auto pep8 error fixes
8176

77+
And more.
8278

8379
.. _indent: http://www.vim.org/scripts/script.php?script_id=974
8480
.. _syntax: http://www.vim.org/scripts/script.php?script_id=790
@@ -101,8 +97,8 @@ already an Emacs user is `Python Programming in Emacs`_ at EmacsWiki.
10197
1. Emacs itself comes with a python mode.
10298
2. Python ships with an alternate version:
10399
`python-mode.el <https://launchpad.net/python-mode>`_
104-
3. Fabián Ezequiel Gallina's provides nice functionality and
105-
behavior out of the box: `python.el <https://github.com/fgallina/python.el>`_
100+
3. Fabián Ezequiel Gallina's `python.el <https://github.com/fgallina/python.el>`_
101+
provides nice functionality and behavior out of the box
106102

107103
.. _Python Programming in Emacs: http://emacswiki.org/emacs/PythonProgrammingInEmacs
108104

@@ -145,16 +141,15 @@ The most popular Eclipse plugin for Python development is Aptana's
145141
Komodo IDE
146142
----------
147143
`Komodo IDE <http://www.activestate.com/komodo-ide>`_ is developed by
148-
ActiveState and is a commercial IDE for Windows, Mac
149-
and Linux.
144+
ActiveState and is a commercial IDE for Windows, Mac and Linux.
150145

151146

152147
Spyder
153148
------
154149

155-
`Spyder <http://code.google.com/p/spyderlib/>`_ an IDE specifically geared
150+
`Spyder <http://code.google.com/p/spyderlib/>`_ is an IDE specifically geared
156151
toward working with scientific python libraries (namely `Scipy <http://www.scipy.org/>`_).
157-
Includes integration with pyflakes_, `pylint <http://www.logilab.org/857>`_,
152+
It includes integration with pyflakes_, `pylint <http://www.logilab.org/857>`_,
158153
and `rope <http://rope.sourceforge.net/>`_.
159154

160155
Spyder is open-source (free), offers code completion, syntax highlighting,
@@ -164,15 +159,15 @@ class and function browser, and object inspection.
164159
WingIDE
165160
-------
166161

167-
`WingIDE <http://wingware.com/>`_ a python specific IDE. Runs for Linux,
162+
`WingIDE <http://wingware.com/>`_ is a python specific IDE. It runs on Linux,
168163
Windows, and Mac (as an X11 application, which frustrates some Mac users).
169164

170165

171166
NINJA-IDE
172167
---------
173168

174169
`NINJA-IDE <http://www.ninja-ide.org/>`_ (from the recursive acronym: "Ninja-IDE
175-
Is Not Just Another IDE", is a cross-platform IDE, specially designed to build
170+
Is Not Just Another IDE") is a cross-platform IDE, specially designed to build
176171
Python applications, and runs on Linux/X11, Mac OS X and Windows desktop operating
177172
systems. Installers for these platforms can be downloaded from the website.
178173

@@ -211,7 +206,7 @@ library which you can use to install other packages. The name of the
211206
virtual environment (in this case, it was ``venv``) can be anything;
212207
omitting the name will place the files in the current directory instead.
213208

214-
In order the start using the virtual environment, run::
209+
To start using the virtual environment, run::
215210

216211
$ source venv/bin/activate
217212

@@ -288,12 +283,12 @@ IDLE
288283

289284
`IDLE <http://docs.python.org/library/idle.html>`_ is an integrated
290285
development environment that is part of Python standard library. It is
291-
completely written in Python and uses Tkinter GUI toolkit. Though IDLE
292-
is not suited for full-blown development using Python , it is quite
286+
completely written in Python and uses the Tkinter GUI toolkit. Though IDLE
287+
is not suited for full-blown development using Python, it is quite
293288
helpful to try out small Python snippets and experiment with different
294289
features in Python.
295290

296-
It provides following features:
291+
It provides the following features:
297292

298293
* Python Shell Window (interpreter)
299294
* Multi window text editor that colorizes Python code

docs/intro/duction.rst

Lines changed: 88 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -1,88 +1,88 @@
1-
Introduction
2-
============
3-
4-
From the `official Python website <http://python.org/about/>`_:
5-
6-
Python is a general-purpose, high-level programming language similar
7-
to Tcl, Perl, Ruby, Scheme, or Java. Some of its main key features
8-
include:
9-
10-
* very clear, readable syntax
11-
12-
Python's philosophy focuses on readability, from code blocks
13-
delineated with significant whitespace to intuitive keywords in
14-
place of inscrutable punctuation
15-
16-
* extensive standard libraries and third party modules for virtually
17-
any task
18-
19-
Python is sometimes described with the words "batteries included"
20-
for its extensive
21-
`standard library <http://docs.python.org/library/>`_, which can
22-
includes modules for regular expressions, file IO, fraction handling,
23-
object serialization, and much more.
24-
25-
Additionally, the
26-
`Python Package Index <http://pypi.python.org/pypi/>`_ is available
27-
for users to submit their packages for widespread use, similar to
28-
Perl's `CPAN <http://www.cpan.org>`_. There is a thriving community
29-
of very powerful Python frameworks and tools like
30-
the `Django <http://www.djangoproject.com>`_ web framework and the
31-
`NumPy <http://numpy.scipy.org>`_ set of math routines.
32-
33-
* integration with other systems
34-
35-
Python can integrate with `Java libraries <http://www.jython.org>`_,
36-
enabling it to be used with the rich Java environment that corporate
37-
programmers are used to. It can also be
38-
`extended by C or C++ modules <http://docs.python.org/extending/>`_
39-
when speed is of the essence.
40-
41-
* ubiquity on computers
42-
43-
Python is available on Windows, \*nix, and Mac. It runs wherever the
44-
Java virtual machine runs, and the reference implementation CPython
45-
can help bring Python to wherever there is a working C compiler.
46-
47-
* friendly community
48-
49-
Python has a vibrant and large :ref:`community <the-community>`
50-
which maintains wikis, conferences, countless repositories,
51-
mailing lists, IRC channels, and so much more. Heck, the Python
52-
community is even helping to write this guide!
53-
54-
55-
.. _about-ref:
56-
57-
About This Guide
58-
----------------
59-
60-
Purpose
61-
~~~~~~~
62-
63-
The Hitchhiker's Guide to Python exists to provide both novice and expert
64-
Python developers a best-practice handbook to the installation, configuration,
65-
and usage of Python on a daily basis.
66-
67-
68-
By the Community
69-
~~~~~~~~~~~~~~~~
70-
71-
This guide is architected and maintained by `Kenneth Reitz
72-
<https://github.com/kennethreitz>`_ in an open fashion. This is a
73-
community-driven effort that serves one purpose: to serve the community.
74-
75-
For the Community
76-
~~~~~~~~~~~~~~~~~
77-
78-
All contributions to the Guide are welcome, from Pythonistas of all levels.
79-
If you think there's a gap in what the Guide covers, fork the Guide on
80-
GitHub and submit a pull request. Contributions are welcome from everyone,
81-
whether they're an old hand or a first-time Pythonista, and the authors to
82-
the Guide will gladly help if you have any questions about the
83-
appropriateness, completeness, or accuracy of a contribution.
84-
85-
To get started working on The Hitchhiker's Guide, see
86-
the: doc:`/notes/contribute` page.
87-
88-
1+
Introduction
2+
============
3+
4+
From the `official Python website <http://python.org/about/>`_:
5+
6+
Python is a general-purpose, high-level programming language similar
7+
to Tcl, Perl, Ruby, Scheme, or Java. Some of its main key features
8+
include:
9+
10+
* very clear, readable syntax
11+
12+
Python's philosophy focuses on readability, from code blocks
13+
delineated with significant whitespace to intuitive keywords in
14+
place of inscrutable punctuation
15+
16+
* extensive standard libraries and third party modules for virtually
17+
any task
18+
19+
Python is sometimes described with the words "batteries included"
20+
for its extensive
21+
`standard library <http://docs.python.org/library/>`_, which includes
22+
modules for regular expressions, file IO, fraction handling,
23+
object serialization, and much more.
24+
25+
Additionally, the
26+
`Python Package Index <http://pypi.python.org/pypi/>`_ is available
27+
for users to submit their packages for widespread use, similar to
28+
Perl's `CPAN <http://www.cpan.org>`_. There is a thriving community
29+
of very powerful Python frameworks and tools like
30+
the `Django <http://www.djangoproject.com>`_ web framework and the
31+
`NumPy <http://numpy.scipy.org>`_ set of math routines.
32+
33+
* integration with other systems
34+
35+
Python can integrate with `Java libraries <http://www.jython.org>`_,
36+
enabling it to be used with the rich Java environment that corporate
37+
programmers are used to. It can also be
38+
`extended by C or C++ modules <http://docs.python.org/extending/>`_
39+
when speed is of the essence.
40+
41+
* ubiquity on computers
42+
43+
Python is available on Windows, \*nix, and Mac. It runs wherever the
44+
Java virtual machine runs, and the reference implementation CPython
45+
can help bring Python to wherever there is a working C compiler.
46+
47+
* friendly community
48+
49+
Python has a vibrant and large :ref:`community <the-community>`
50+
which maintains wikis, conferences, countless repositories,
51+
mailing lists, IRC channels, and so much more. Heck, the Python
52+
community is even helping to write this guide!
53+
54+
55+
.. _about-ref:
56+
57+
About This Guide
58+
----------------
59+
60+
Purpose
61+
~~~~~~~
62+
63+
The Hitchhiker's Guide to Python exists to provide both novice and expert
64+
Python developers a best-practice handbook to the installation, configuration,
65+
and usage of Python on a daily basis.
66+
67+
68+
By the Community
69+
~~~~~~~~~~~~~~~~
70+
71+
This guide is architected and maintained by `Kenneth Reitz
72+
<https://github.com/kennethreitz>`_ in an open fashion. This is a
73+
community-driven effort that serves one purpose: to serve the community.
74+
75+
For the Community
76+
~~~~~~~~~~~~~~~~~
77+
78+
All contributions to the Guide are welcome, from Pythonistas of all levels.
79+
If you think there's a gap in what the Guide covers, fork the Guide on
80+
GitHub and submit a pull request. Contributions are welcome from everyone,
81+
whether they're an old hand or a first-time Pythonista, and the authors to
82+
the Guide will gladly help if you have any questions about the
83+
appropriateness, completeness, or accuracy of a contribution.
84+
85+
To get started working on The Hitchhiker's Guide, see
86+
the: doc:`/notes/contribute` page.
87+
88+

docs/notes/styleguide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
The Guide Style Guide
55
=====================
66

7-
As with all documentation, having a consistent formating helps make the
7+
As with all documentation, having a consistent format helps make the
88
document more understandable. In order to make The Guide easier to digest,
99
all contributions should fit within the rules of this style guide where
1010
appropriate.

docs/shipping/freezing.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,19 @@ Comparison
2020
Solutions and platforms/features supported:
2121

2222
=========== ======= ===== ==== ======== ======= ============= ============== ==== =====================
23-
Solution Windows Linux OS X Python 3 Licence One-file mode Zipfile import Eggs pkg_resources support
23+
Solution Windows Linux OS X Python 3 License One-file mode Zipfile import Eggs pkg_resources support
2424
=========== ======= ===== ==== ======== ======= ============= ============== ==== =====================
25-
bbFreeze yes yes yes no MIT no yes yes yes
26-
py2exe yes no no no MIT yes yes no no
27-
pyInstaller yes yes yes no GPL yes no yes no
28-
cx_Freeze yes yes yes yes PSF no yes yes no
25+
bbFreeze yes yes yes no MIT no yes yes yes
26+
py2exe yes no no no MIT yes yes no no
27+
pyInstaller yes yes yes no GPL yes no yes no
28+
cx_Freeze yes yes yes yes PSF no yes yes no
2929
=========== ======= ===== ==== ======== ======= ============= ============== ==== =====================
3030

3131
.. todo:: Add other solutions: py2app
3232

3333
.. note::
3434
Freezing Python code on Linux into a Windows executable was only once
35-
supported in PyInstaller, `but later dropped
35+
supported in PyInstaller `and later dropped.
3636
<http://stackoverflow.com/questions/2950971/cross-compiling-a-python-script-on-linux-into-a-windows-executable#comment11890276_2951046>`_.
3737

3838
.. note::

docs/starting/install/win.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Installing Python on Windows
44
============================
55

66
First, download the `latest version <http://python.org/ftp/python/2.7.3/python-2.7.3.msi>`_
7-
of Python 2 from the official Website. If you want to be sure you are installing a fully
7+
of Python 2.7 from the official Website. If you want to be sure you are installing a fully
88
up-to-date version then use the "Windows Installer" link from the home page of the
99
`Python.org web site <http://python.org>`_ .
1010

docs/starting/which-python.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Which Python to use?
1818
Today
1919
-----
2020

21-
If you're choosing a Python interpreter to use, I *highly* recommend you Use
21+
If you're choosing a Python interpreter to use, I *highly* recommend you use
2222
Python 2.7.x, unless you have a strong reason not to.
2323

2424

0 commit comments

Comments
 (0)