diff --git a/docs/dev/env.rst b/docs/dev/env.rst index 67b96be..50ddbb0 100644 --- a/docs/dev/env.rst +++ b/docs/dev/env.rst @@ -233,7 +233,7 @@ The name of the current virtual environment will now appear on the left of the prompt (e.g. ``(venv)Your-Computer:your_project UserName$``) to let you know that it's active. From now on, any package that you install using ``pip`` will be placed in the ``venv`` folder, isolated from the global -Python installation. +Python installation. Install packages as usual: diff --git a/docs/intro/duction.rst b/docs/intro/duction.rst index 152ea54..9358390 100644 --- a/docs/intro/duction.rst +++ b/docs/intro/duction.rst @@ -77,11 +77,11 @@ For the Community All contributions to the Guide are welcome, from Pythonistas of all levels. If you think there's a gap in what the Guide covers, fork the Guide on -GitHub and submit a pull request. +GitHub and submit a pull request. -Contributions are welcome from everyone, whether they're an old hand or a -first-time Pythonista, and the authors to the Guide will gladly help if you -have any questions about the appropriateness, completeness, or accuracy of +Contributions are welcome from everyone, whether they're an old hand or a +first-time Pythonista, and the authors to the Guide will gladly help if you +have any questions about the appropriateness, completeness, or accuracy of a contribution. To get started working on The Hitchhiker's Guide, see the :doc:`/notes/contribute` page. diff --git a/docs/intro/learning.rst b/docs/intro/learning.rst index f65f700..2436cea 100644 --- a/docs/intro/learning.rst +++ b/docs/intro/learning.rst @@ -201,7 +201,7 @@ Programming Collective Intelligence ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Programming Collective Intelligence introduces a wide array of basic machine learning and -data mining methods. The exposition is not very mathematically formal, but rather focuses +data mining methods. The exposition is not very mathematically formal, but rather focuses on explaining the underlying intuition and shows how to implement the algorithms in Python. `Programming Collective Intelligence `_ @@ -225,7 +225,7 @@ This is Python's reference manual, it covers the syntax and the core semantics o language. `The Python Language Reference `_ - + Python Pocket Reference ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -239,7 +239,7 @@ Writing Idiomatic Python ~~~~~~~~~~~~~~~~~~~~~~~~ "Writing Idiomatic Python", written by Jeff Knupp, contains the most common and -important Python idioms in a format that maximizes identification and understanding. +important Python idioms in a format that maximizes identification and understanding. Each idiom is presented as a recommendation of a way to write some commonly used piece of code, followed by an explanation of why the idiom is important. It also contains two code samples for each idiom: the "Harmful" way to write it diff --git a/docs/scenarios/ci.rst b/docs/scenarios/ci.rst index d45cd89..7923c8e 100644 --- a/docs/scenarios/ci.rst +++ b/docs/scenarios/ci.rst @@ -40,7 +40,7 @@ anywhere. You can use Mule to intelligently manage message routing, data mapping, orchestration, reliability, security and scalability between nodes. Plug other systems and applications into Mule and let it handle all the communication between systems, enabling you to track and monitor everything -that happens. +that happens. Tox diff --git a/docs/scenarios/client.rst b/docs/scenarios/client.rst index b7494b0..d589a47 100644 --- a/docs/scenarios/client.rst +++ b/docs/scenarios/client.rst @@ -45,10 +45,10 @@ library is designed to have a familiar socket-style API. RabbitMQ -------- -RabbitMQ is an open source message broker software that implements the Advanced Message Queuing Protocol (AMQP). -The RabbitMQ server is written in the Erlang programming language and is built on the Open Telecom Platform -framework for clustering and failover. Client libraries to interface with the broker are available +RabbitMQ is an open source message broker software that implements the Advanced Message Queuing Protocol (AMQP). +The RabbitMQ server is written in the Erlang programming language and is built on the Open Telecom Platform +framework for clustering and failover. Client libraries to interface with the broker are available for all major programming languages. -- `Homepage `_ +- `Homepage `_ - `GitHub Organization `_ diff --git a/docs/scenarios/gui.rst b/docs/scenarios/gui.rst index fae55bb..e2219b3 100644 --- a/docs/scenarios/gui.rst +++ b/docs/scenarios/gui.rst @@ -10,7 +10,7 @@ applications on top of Python, SQLAlchemy and Qt. It is inspired by the Django admin interface. The main resource for information is the website: -http://www.python-camelot.com +http://www.python-camelot.com and the mailing list https://groups.google.com/forum/#!forum/project-camelot Cocoa diff --git a/docs/writing/documentation.rst b/docs/writing/documentation.rst index e5600c7..0aeb77b 100644 --- a/docs/writing/documentation.rst +++ b/docs/writing/documentation.rst @@ -93,13 +93,13 @@ Reference`_ should help you familiarize yourself with its syntax. Code Documentation Advice ------------------------- -Comments clarify the code and they are added with purpose of making the -code easier to understand. In Python, comments begin with a hash +Comments clarify the code and they are added with purpose of making the +code easier to understand. In Python, comments begin with a hash (number sign) (``#``). .. _docstring-ref: -In Python, *docstrings* describe modules, classes, and functions: +In Python, *docstrings* describe modules, classes, and functions: .. code-block:: python @@ -168,7 +168,7 @@ Epydoc_ .. _Epydoc: http://epydoc.sourceforge.net MkDocs_ - MkDocs is a fast and simple static site generator that's geared towards + MkDocs is a fast and simple static site generator that's geared towards building project documentation with Markdown. .. _MkDocs: http://www.mkdocs.org/ diff --git a/docs/writing/gotchas.rst b/docs/writing/gotchas.rst index 5ed5669..a59eb9b 100644 --- a/docs/writing/gotchas.rst +++ b/docs/writing/gotchas.rst @@ -172,7 +172,7 @@ Alternatively, you can use the functools.partial function: from functools import partial from operator import mul - + def create_multipliers(): return [partial(mul, i) for i in range(5)]