Skip to content

Commit a622afa

Browse files
committed
More typo, grammar, and style fixes
1 parent 0dfc4c3 commit a622afa

25 files changed

+201
-202
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ pip install --user sphinx
1717

1818
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/`
1919

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

2222
``` bash
2323
python3 -m http.server

docs/dev/env.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ Spyder
188188

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

docs/intro/documentation.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,14 @@ pydoc
3535
:program:`pydoc` is a utility that is installed when you install Python.
3636
It allows you to quickly retrieve and search for documentation from your
3737
shell. For example, if you needed a quick refresher on the
38-
:mod:`time` module, pulling up documentation would be as simple as
38+
:mod:`time` module, pulling up documentation would be as simple as:
3939

4040
.. code-block:: console
4141
4242
$ pydoc time
4343
4444
The above command is essentially equivalent to opening the Python REPL
45-
and running
45+
and running:
4646

4747
.. code-block:: pycon
4848

docs/intro/learning.rst

+24-22
Original file line numberDiff line numberDiff line change
@@ -37,24 +37,26 @@ pythonbasics.org is an introductiory tutorial for beginners. The tutorial includ
3737
Python for Beginners
3838
~~~~~~~~~~~~~~~~~~~~
3939

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

44-
45-
`Python for beginners <http://thepythonguru.com/>`_
44+
`Python for Beginners <http://thepythonguru.com/>`_
4645

4746
Learn Python Interactive Tutorial
4847
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4948

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

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

57+
Python for You and Me
58+
~~~~~~~~~~~~~~~~~~~~~
59+
5860
If you want a more traditional book, *Python For You and Me* is an excellent
5961
resource for learning all aspects of the language.
6062

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

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

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

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

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

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

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

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

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

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

213215
Effective Python
214216
~~~~~~~~~~~~~~~~
215217

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

@@ -241,13 +243,13 @@ Expert Python Programming deals with best practices in programming Python and
241243
is focused on the more advanced crowd.
242244

243245
It starts with topics like decorators (with caching, proxy, and context manager
244-
case-studies), method resolution order, using super() and meta-programming, and
246+
case studies), method resolution order, using super() and meta-programming, and
245247
general :pep:`8` best practices.
246248

247249
It has a detailed, multi-chapter case study on writing and releasing a package
248250
and eventually an application, including a chapter on using zc.buildout. Later
249251
chapters detail best practices such as writing documentation, test-driven
250-
development, version control, optimization and profiling.
252+
development, version control, optimization, and profiling.
251253

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

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

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

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

267269

@@ -317,7 +319,7 @@ Transforming Code into Beautiful, Idiomatic Python
317319

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

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

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

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

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

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

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

361363
The Python Language Reference
362364
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
363365

364-
This is Python's reference manual, it covers the syntax and the core semantics
366+
This is Python's reference manual. It covers the syntax and the core semantics
365367
of the language.
366368

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

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

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

396398
Writing Idiomatic Python
397399
~~~~~~~~~~~~~~~~~~~~~~~~
398400

399-
"Writing Idiomatic Python", written by Jeff Knupp, contains the most common and
401+
Writing Idiomatic Python, written by Jeff Knupp, contains the most common and
400402
important Python idioms in a format that maximizes identification and
401403
understanding. Each idiom is presented as a recommendation of a way to write
402404
some commonly used piece of code, followed by an explanation of why the idiom

docs/intro/news.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Python News is the news section in the official Python web site
8787
Import Python Weekly
8888
********************
8989

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

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

100-
A weekly overview of the most popular Python news, articles and packages.
100+
A weekly overview of the most popular Python news, articles, and packages.
101101

102102
`Awesome Python Newsletter <https://python.libhunt.com/newsletter>`_

docs/notes/styleguide.rst

+2-3
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ Python examples:
135135
Externally Linking
136136
******************
137137

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

140140
.. code-block:: rest
141141
@@ -150,7 +150,7 @@ Externally Linking
150150
151151
Read the `Sphinx Tutorial <http://sphinx.pocoo.org/tutorial.html>`_
152152
153-
* Avoid using labels such as "click here", "this", etc. preferring
153+
* Avoid using labels such as "click here", "this", etc., preferring
154154
descriptive labels (SEO worthy) instead.
155155

156156

@@ -209,4 +209,3 @@ documents or large incomplete sections.
209209
.. todo::
210210
Learn the Ultimate Answer to the Ultimate Question
211211
of Life, The Universe, and Everything
212-

docs/scenarios/admin.rst

+15-15
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Install Fabric:
2323
2424
The following code will create two tasks that we can use: ``memory_usage`` and
2525
``deploy``. The former will output the memory usage on each machine. The
26-
latter will ssh into each server, cd to our project directory, activate the
26+
latter will SSH into each server, cd to our project directory, activate the
2727
virtual environment, pull the newest codebase, and restart the application
2828
server.
2929

@@ -101,7 +101,7 @@ The following command lists all available minion hosts, using the ping module.
101101
102102
$ salt '*' test.ping
103103
104-
The host filtering is accomplished by matching the minion id,
104+
The host filtering is accomplished by matching the minion id
105105
or using the grains system. The
106106
`grains <http://docs.saltstack.org/en/latest/topics/targeting/grains.html>`_
107107
system uses static host information like the operating system version or the
@@ -131,7 +131,7 @@ it will install and start the Apache server:
131131
- require:
132132
- pkg: apache
133133
134-
State files can be written using YAML, the Jinja2 template system or pure Python.
134+
State files can be written using YAML, the Jinja2 template system, or pure Python.
135135

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

@@ -141,7 +141,7 @@ Psutil
141141
******
142142

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

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

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

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

@@ -299,8 +299,8 @@ Puppet Agents are installed on nodes whose state needs to be monitored or
299299
changed. A designated server known as the Puppet Master is responsible for
300300
orchestrating the agent nodes.
301301

302-
Agent nodes send basic facts about the system such as to the operating system,
303-
kernel, architecture, ip address, hostname etc. to the Puppet Master.
302+
Agent nodes send basic facts about the system such as the operating system,
303+
kernel, architecture, IP address, hostname, etc. to the Puppet Master.
304304
The Puppet Master then compiles a catalog with information provided by the
305305
agents on how each node should be configured and sends it to the agent. The
306306
agent enforces the change as prescribed in the catalog and sends a report back
@@ -320,7 +320,7 @@ your Puppet modules.
320320
Ubuntu
321321
322322
Writing Modules in Puppet is pretty straight forward. Puppet Manifests together
323-
form Puppet Modules. Puppet manifest end with an extension of ``.pp``.
323+
form Puppet Modules. Puppet manifests end with an extension of ``.pp``.
324324
Here is an example of 'Hello World' in Puppet.
325325

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

339339
.. code-block:: puppet
340340
@@ -346,10 +346,10 @@ holds true for other facts such as hostname which can be referenced by
346346
}
347347
348348
There are several resource types for Puppet but the package-file-service
349-
paradigm is all you need for undertaking majority of the configuration
349+
paradigm is all you need for undertaking the majority of the configuration
350350
management. The following Puppet code makes sure that the OpenSSH-Server
351351
package is installed in a system and the sshd service is notified to restart
352-
everytime the sshd configuration file is changed.
352+
every time the sshd configuration file is changed.
353353

354354
.. code-block:: puppet
355355
@@ -407,6 +407,6 @@ monitoring framework written in Python. Its main goal is to give users a flexibl
407407
architecture for their monitoring system that is designed to scale to large
408408
environments.
409409

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

0 commit comments

Comments
 (0)