Skip to content

More typo, grammar, and style fixes #955

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 21, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ pip install --user sphinx

Then navigate to the directory of the Makefile and ```make build``` or ```make html```. Sphinx will then generate the HTML in a folder called `_build/html/`

After navigating to this folder, you can then use Python's built in webserver to view your changes locally:
After navigating to this folder, you can then use Python's built in web server to view your changes locally:

``` bash
python3 -m http.server
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/env.rst
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ Spyder

`Spyder <https://github.com/spyder-ide/spyder>`_ is an IDE specifically geared
toward working with scientific Python libraries (namely
`Scipy <http://www.scipy.org/>`_). It includes integration with pyflakes_,
`SciPy <http://www.scipy.org/>`_). It includes integration with pyflakes_,
`pylint <http://www.logilab.org/857>`_ and
`rope <https://github.com/python-rope/rope>`_.

Expand Down
4 changes: 2 additions & 2 deletions docs/intro/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,14 @@ pydoc
: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
:mod:`time` module, pulling up documentation would be as simple as:

.. code-block:: console

$ pydoc time

The above command is essentially equivalent to opening the Python REPL
and running
and running:

.. code-block:: pycon

Expand Down
46 changes: 24 additions & 22 deletions docs/intro/learning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,24 +37,26 @@ pythonbasics.org is an introductiory tutorial for beginners. The tutorial includ
Python for Beginners
~~~~~~~~~~~~~~~~~~~~

thepythonguru.com is a tutorial focuses on beginner programmers. It covers many python concepts
in depth. It also teaches you some advance constructs of python like lambda expression, regular expression.
At last it finishes off with tutorial "How to access MySQL db using python"
thepythonguru.com is a tutorial focused on beginner programmers. It covers many Python concepts
in depth. It also teaches you some advanced constructs of Python like lambda expressions and regular expressions.
And last it finishes off with the tutorial "How to access MySQL db using Python"


`Python for beginners <http://thepythonguru.com/>`_
`Python for Beginners <http://thepythonguru.com/>`_

Learn Python Interactive Tutorial
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Learnpython.org is an easy non-intimidating way to get introduced to Python.
The website takes the same approach used on the popular
`Try Ruby <http://tryruby.org/>`_ website, it has an interactive Python
`Try Ruby <http://tryruby.org/>`_ website. It has an interactive Python
interpreter built into the site that allows you to go through the lessons
without having to install Python locally.

`Learn Python <http://www.learnpython.org/>`_

Python for You and Me
~~~~~~~~~~~~~~~~~~~~~

If you want a more traditional book, *Python For You and Me* is an excellent
resource for learning all aspects of the language.

Expand All @@ -71,7 +73,7 @@ Techbeamers.com provides step-by-step tutorials to teach Python. Each tutorial i
Online Python Tutor
~~~~~~~~~~~~~~~~~~~

Online Python Tutor gives you a visual step by step
Online Python Tutor gives you a visual step-by-step
representation of how your program runs. Python Tutor
helps people overcome a fundamental barrier to learning
programming by understanding what happens as the computer
Expand Down Expand Up @@ -133,15 +135,15 @@ Think Python: How to Think Like a Computer Scientist

Think Python attempts to give an introduction to basic concepts in computer
science through the use of the Python language. The focus was to create a book
with plenty of exercises, minimal jargon and a section in each chapter devoted
with plenty of exercises, minimal jargon, and a section in each chapter devoted
to the subject of debugging.

While exploring the various features available in the Python language the
author weaves in various design patterns and best practices.

The book also includes several case studies which have the reader explore the
topics discussed in the book in greater detail by applying those topics to
real-world examples. Case studies include assignments in GUI and Markov
real-world examples. Case studies include assignments in GUI programming and Markov
Analysis.

`Think Python <http://greenteapress.com/thinkpython/html/index.html>`_
Expand Down Expand Up @@ -191,7 +193,7 @@ Code the blocks
*Code the blocks* provides free and interactive Python tutorials for
beginners. It combines Python programming with a 3D environment where
you "place blocks" and construct structures. The tutorials teach you
how to use Python to create progressively elaborate 3D structures,
how to use Python to create progressively more elaborate 3D structures,
making the process of learning Python fun and engaging.

`Code the blocks <https://codetheblocks.com/tutorials/introduction>`_
Expand All @@ -204,17 +206,17 @@ Intermediate
Python Tricks: The Book
~~~~~~~~~~~~~~~~~~~~~~~

Discover Python's best practices with simple examples and start writing even more beautiful + Pythonic code. "Python Tricks: The Book" shows you exactly how.
Discover Python's best practices with simple examples and start writing even more beautiful + Pythonic code. *Python Tricks: The Book* shows you exactly how.

You’ll master intermediate and advanced-level features in Python with practical examples and a clear narrative:
You’ll master intermediate and advanced-level features in Python with practical examples and a clear narrative.

`Python Tricks: The Book <https://realpython.com/products/python-tricks-book/>`_

Effective Python
~~~~~~~~~~~~~~~~

This book contains 59 specific ways to improve writing Pythonic code. At 227
pages, it is a very brief overview of some of the most commons adapations
pages, it is a very brief overview of some of the most common adapations
programmers need to make to become efficient intermediate level Python
programmers.

Expand All @@ -241,13 +243,13 @@ Expert Python Programming deals with best practices in programming Python and
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
case studies), method resolution order, using super() and meta-programming, and
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
chapters detail best practices such as writing documentation, test-driven
development, version control, optimization and profiling.
development, version control, optimization, and profiling.

`Expert Python Programming <http://www.packtpub.com/expert-python-programming/book>`_

Expand All @@ -261,7 +263,7 @@ and can make classes and objects behave in different and magical ways.

`A Guide to Python's Magic Methods <http://www.rafekettler.com/magicmethods.html>`_

.. note:: The Rafekettler.com is currently down, you can go to their Github version directly. Here you can find a PDF version:
.. note:: Rafekettler.com is currently down; you can go to their GitHub version directly. Here you can find a PDF version:
`A Guide to Python's Magic Methods (repo on GitHub) <https://github.com/RafeKettler/magicmethods/blob/master/magicmethods.pdf>`_


Expand Down Expand Up @@ -317,7 +319,7 @@ Transforming Code into Beautiful, Idiomatic Python

Transforming Code into Beautiful, Idiomatic Python is a video by Raymond Hettinger.
Learn to take better advantage of Python's best features and improve existing code
through a series of code transformations, "When you see this, do that instead."
through a series of code transformations: "When you see this, do that instead."

`Transforming Code into Beautiful, Idiomatic Python <https://www.youtube.com/watch?v=OSGv2VnC0go>`_

Expand All @@ -328,7 +330,7 @@ Fullstack Python
Fullstack Python offers a complete top-to-bottom resource for web development
using Python.

From setting up the webserver, to designing the front-end, choosing a database,
From setting up the web server, to designing the front-end, choosing a database,
optimizing/scaling, etc.

As the name suggests, it covers everything you need to build and run a complete
Expand All @@ -353,15 +355,15 @@ Python in a Nutshell
~~~~~~~~~~~~~~~~~~~~

Python in a Nutshell, written by Alex Martelli, covers most cross-platform
Python's usage, from its syntax to built-in libraries to advanced topics such
Python usage, from its syntax to built-in libraries to advanced topics such
as writing C extensions.

`Python in a Nutshell <http://shop.oreilly.com/product/9780596001889.do>`_

The Python Language Reference
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This is Python's reference manual, it covers the syntax and the core semantics
This is Python's reference manual. It covers the syntax and the core semantics
of the language.

`The Python Language Reference <http://docs.python.org/reference/index.html>`_
Expand All @@ -388,15 +390,15 @@ Python Cookbook
~~~~~~~~~~~~~~~

Python Cookbook, written by David Beazley and Brian K. Jones, is packed with
practical recipes. This book covers the core python language as well as tasks
practical recipes. This book covers the core Python language as well as tasks
common to a wide variety of application domains.

`Python Cookbook <http://shop.oreilly.com/product/0636920027072.do>`_

Writing Idiomatic Python
~~~~~~~~~~~~~~~~~~~~~~~~

"Writing Idiomatic Python", written by Jeff Knupp, contains the most common and
Writing Idiomatic Python, written by Jeff Knupp, contains the most common and
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
Expand Down
4 changes: 2 additions & 2 deletions docs/intro/news.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Python News is the news section in the official Python web site
Import Python Weekly
********************

Weekly Python Newsletter containing Python Articles, Projects, Videos, Tweets
Weekly Python Newsletter containing Python Articles, Projects, Videos, and Tweets
delivered in your inbox. Keep Your Python Programming Skills Updated.

`Import Python Weekly Newsletter <http://www.importpython.com/newsletter/>`_
Expand All @@ -97,6 +97,6 @@ delivered in your inbox. Keep Your Python Programming Skills Updated.
Awesome Python Newsletter
*************************

A weekly overview of the most popular Python news, articles and packages.
A weekly overview of the most popular Python news, articles, and packages.

`Awesome Python Newsletter <https://python.libhunt.com/newsletter>`_
4 changes: 2 additions & 2 deletions docs/notes/styleguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ Python examples:
Externally Linking
******************

* Prefer labels for well known subjects (ex: proper nouns) when linking:
* Prefer labels for well known subjects (e.g. proper nouns) when linking:

.. code-block:: rest

Expand All @@ -152,7 +152,7 @@ Externally Linking

Read the `Sphinx Tutorial <http://sphinx.pocoo.org/tutorial.html>`_

* Avoid using labels such as "click here", "this", etc. preferring
* Avoid using labels such as "click here", "this", etc., preferring
descriptive labels (SEO worthy) instead.


Expand Down
30 changes: 15 additions & 15 deletions docs/scenarios/admin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Install Fabric:

The following code will create two tasks that we can use: ``memory_usage`` and
``deploy``. The former will output the memory usage on each machine. The
latter will ssh into each server, cd to our project directory, activate the
latter will SSH into each server, cd to our project directory, activate the
virtual environment, pull the newest codebase, and restart the application
server.

Expand Down Expand Up @@ -101,7 +101,7 @@ The following command lists all available minion hosts, using the ping module.

$ salt '*' test.ping

The host filtering is accomplished by matching the minion id,
The host filtering is accomplished by matching the minion id
or using the grains system. The
`grains <http://docs.saltstack.org/en/latest/topics/targeting/grains.html>`_
system uses static host information like the operating system version or the
Expand Down Expand Up @@ -131,7 +131,7 @@ it will install and start the Apache server:
- require:
- pkg: apache

State files can be written using YAML, the Jinja2 template system or pure Python.
State files can be written using YAML, the Jinja2 template system, or pure Python.

`Salt Documentation <http://docs.saltstack.com>`_

Expand All @@ -141,7 +141,7 @@ Psutil
******

`Psutil <https://github.com/giampaolo/psutil/>`_ is an interface to different
system information (e.g. CPU, memory, disks, network, users and processes).
system information (e.g. CPU, memory, disks, network, users, and processes).

Here is an example to be aware of some server overload. If any of the
tests (net, CPU) fail, it will send an email.
Expand Down Expand Up @@ -263,9 +263,9 @@ configures itself and this distributed approach makes Chef a scalable automation

Chef works by using custom recipes (configuration elements), implemented in cookbooks. Cookbooks, which are basically
packages for infrastructure choices, are usually stored in your Chef server.
Read the `Digital Ocean tutorial series
Read the `DigitalOcean tutorial series
<https://www.digitalocean.com/community/tutorials/how-to-install-a-chef-server-workstation-and-client-on-ubuntu-vps-instances>`_
on chef to learn how to create a simple Chef Server.
on Chef to learn how to create a simple Chef Server.

To create a simple cookbook the `knife <https://docs.chef.io/knife.html>`_ command is used:

Expand Down Expand Up @@ -299,8 +299,8 @@ Puppet Agents are installed on nodes whose state needs to be monitored or
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.
Agent nodes send basic facts about the system such as the operating system,
kernel, architecture, IP address, hostname, etc. to the Puppet Master.
The Puppet Master then compiles a catalog with information provided by the
agents on how each node should be configured and sends it to the agent. The
agent enforces the change as prescribed in the catalog and sends a report back
Expand All @@ -320,7 +320,7 @@ your Puppet modules.
Ubuntu

Writing Modules in Puppet is pretty straight forward. Puppet Manifests together
form Puppet Modules. Puppet manifest end with an extension of ``.pp``.
form Puppet Modules. Puppet manifests end with an extension of ``.pp``.
Here is an example of 'Hello World' in Puppet.

.. code-block:: puppet
Expand All @@ -334,7 +334,7 @@ Here is an example of 'Hello World' in Puppet.
Here is another example with system based logic. Note how the operating system
fact is being used as a variable prepended with the ``$`` sign. Similarly, this
holds true for other facts such as hostname which can be referenced by
``$hostname``
``$hostname``.

.. code-block:: puppet

Expand All @@ -346,10 +346,10 @@ holds true for other facts such as hostname which can be referenced by
}

There are several resource types for Puppet but the package-file-service
paradigm is all you need for undertaking majority of the configuration
paradigm is all you need for undertaking the majority of the configuration
management. The following Puppet code makes sure that the OpenSSH-Server
package is installed in a system and the sshd service is notified to restart
everytime the sshd configuration file is changed.
every time the sshd configuration file is changed.

.. code-block:: puppet

Expand Down Expand Up @@ -407,6 +407,6 @@ monitoring framework written in Python. Its main goal is to give users a flexibl
architecture for their monitoring system that is designed to scale to large
environments.

Shinken is backwards-compatible with the Nagios configuration standard, and
plugins.It works on any operating system, and architecture that supports Python
which includes Windows, GNU/Linux, and FreeBSD.
Shinken is backwards-compatible with the Nagios configuration standard and
plugins. It works on any operating system and architecture that supports Python,
which includes Windows, Linux, and FreeBSD.
Loading