diff --git a/docs/intro/documentation.rst b/docs/intro/documentation.rst index dd5053ff7..1db5bcedb 100644 --- a/docs/intro/documentation.rst +++ b/docs/intro/documentation.rst @@ -23,7 +23,7 @@ both popular and exotic. pydoc ----- -:program:`pydoc` is a utlity that is installed when you install Python. +:program:`pydoc` is a utility that is installed when you install Python. It allows you to quickly retrieve and search for documentation from your shell. For example, if you needed a quick refresher on the :mod:`time` module, pulling up documentation would be as simple as diff --git a/docs/scenarios/admin.rst b/docs/scenarios/admin.rst index 172e1289d..954e1f6ad 100644 --- a/docs/scenarios/admin.rst +++ b/docs/scenarios/admin.rst @@ -255,8 +255,8 @@ system. `Puppet Forge `_ is a repository for modules written by the community for Open Source and Enterprise Puppet. Puppet Agents are installed on nodes whose state needs to be monitored or -changed. A desginated server known as the Puppet Master is responsible for -orchastrating the agent nodes. +changed. A designated server known as the Puppet Master is responsible for +orchestrating the agent nodes. Agent nodes send basic facts about the system such as to the operating system, kernel, architecture, ip address, hostname etc. to the Puppet Master. diff --git a/docs/scenarios/gui.rst b/docs/scenarios/gui.rst index 19e888d1c..466dec066 100644 --- a/docs/scenarios/gui.rst +++ b/docs/scenarios/gui.rst @@ -15,7 +15,7 @@ and the mailing list https://groups.google.com/forum/#!forum/project-camelot Cocoa ----- -.. note:: The Cocoa framework is only available on OS X. Don't pick this if you're writing a cross-platform application! +.. note:: The Cocoa framework is only available on OS X. Don't pick this if you're writing a cross-platform application! GTk --- diff --git a/docs/shipping/freezing.rst b/docs/shipping/freezing.rst index e333f6976..64c0780b3 100644 --- a/docs/shipping/freezing.rst +++ b/docs/shipping/freezing.rst @@ -107,7 +107,7 @@ Prerequisite is to have installed :ref:`Python, Setuptools and pywin32 dependenc - `Manual `_ -OS X +OS X ---- diff --git a/docs/shipping/packaging.rst b/docs/shipping/packaging.rst index 2fa1ca7ab..1c659610f 100644 --- a/docs/shipping/packaging.rst +++ b/docs/shipping/packaging.rst @@ -23,7 +23,7 @@ The downside of distributing code like this is that it relies on the recipient understanding how to install the required version of Python, and being able and willing to use tools such as pip to install your code's other dependencies. This is fine when distributing to other developers, but -makes this method unsuitable for distributing applications to end-uers. +makes this method unsuitable for distributing applications to end-users. The `Python Packaging Guide `_ provides an extensive guide on creating and maintaining Python packages. diff --git a/docs/starting/pip-virtualenv.rst b/docs/starting/pip-virtualenv.rst index fedcbe120..51927e689 100644 --- a/docs/starting/pip-virtualenv.rst +++ b/docs/starting/pip-virtualenv.rst @@ -6,7 +6,7 @@ Further Configuration of Pip and Virtualenv Requiring an active virtual environment for ``pip`` --------------------------------------------------- -By now it should be clear that using virtual envirtonments is a great way to +By now it should be clear that using virtual environments is a great way to keep your development environment clean and keeping different projects' requirements separate. @@ -71,7 +71,7 @@ add the following lines to this new file: You will of course need to install some packages globally (usually ones that -you use across different projects consistenly) and this can be accomplished by +you use across different projects consistently) and this can be accomplished by adding the following to your :file:`~/.bashrc` file: .. code-block:: console @@ -94,7 +94,7 @@ that you use. For example, you may be using the ``requests`` library in a lot of different projects. It is surely unnecessary to re-download the same packages/libraries each time -you start working on a new project (and in a new virtual environmen as a result). +you start working on a new project (and in a new virtual environment as a result). Fortunately, you can configure pip in such a way that it tries to reuse already installed packages. diff --git a/docs/writing/documentation.rst b/docs/writing/documentation.rst index 85f48de42..58a3107c4 100644 --- a/docs/writing/documentation.rst +++ b/docs/writing/documentation.rst @@ -141,7 +141,7 @@ comment block is a programmer's note. The docstring describes the """Returns the square root of self times self.""" ... -.. seealso:: Further reading on docstrings: :pep:`257` +.. see also:: Further reading on docstrings: :pep:`257` Other Tools diff --git a/docs/writing/style.rst b/docs/writing/style.rst index ae37cf6e3..5e661516c 100644 --- a/docs/writing/style.rst +++ b/docs/writing/style.rst @@ -6,7 +6,7 @@ Code Style If you ask Python programmers what they like most in Python, they will often say its high readability. Indeed, a high level of readability is at the heart of the design of the Python language, following the -recognised fact that code is read much more often than it is written. +recognized fact that code is read much more often than it is written. One reason for Python code to be easily read and understood is its relatively complete set of Code Style guidelines and "Pythonic" idioms.