Skip to content

Commit d950093

Browse files
author
Kenneth Reitz
committed
Merge pull request realpython#249 from barisumog/master
minor typos and omitted words
2 parents b3f1e96 + a076120 commit d950093

File tree

5 files changed

+11
-11
lines changed

5 files changed

+11
-11
lines changed

docs/writing/documentation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Project Publication
3737
Depending on the project, your documentation might include some or all
3838
of the following components:
3939

40-
- A *introduction* should show a very short overview of what can be
40+
- An *introduction* should show a very short overview of what can be
4141
done with the product, using one or two extremely simplified use
4242
cases. This is the thirty-second pitch for your project.
4343

docs/writing/gotchas.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Common Gotchas
22
==============
33

44
For the most part, Python aims to be a clean and consistent language that
5-
avoid surprises, but there are a few cases where newcomers to the language
5+
avoids surprises, but there are a few cases where newcomers to the language
66
often get tripped up.
77

88
Some of these are intentional but potentially surprising. Some could arguably

docs/writing/reading.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ One of the secrets of becoming a great Python programmer is to read,
99
understand, and comprehend excellent code.
1010

1111
Excellent code typically follows the guidelines outlined in :ref:`code_style`,
12-
and does its best to express a clear and consise intent to the reader.
12+
and does its best to express a clear and concise intent to the reader.
1313

1414
Included below is a list of recommended Python projects for reading. Each of
1515
these projects are paragons of excellent Python code.
@@ -41,4 +41,4 @@ these projects are paragons of excellent Python code.
4141

4242
.. todo:: Include code examples of exemplary code from each of the projects listed. Explain why it is excellent code. Use complex examples.
4343

44-
.. todo:: Explain techniques to rapidly identify data structures, algorithms and determine what the code is doing.
44+
.. todo:: Explain techniques to rapidly identify data structures, algorithms and determine what the code is doing.

docs/writing/style.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ passed another value.
109109
Calling a function with keyword arguments can be done in multiple ways in Python,
110110
for example it is possible to follow the order of arguments in the definition without
111111
explicitly naming the arguments, like in ``send('Hello', 'World', 'Cthulhu', 'God')``,
112-
sending a blank carbon copy to God. It would also be possible to name arguments in
112+
sending a blind carbon copy to God. It would also be possible to name arguments in
113113
another order, like in ``send('Hello again', 'World', bcc='God', cc='Cthulhu')``.
114114
Those two possibilities are better avoided without any strong reason to not
115115
follow the syntax that is the closest to the function definition: ``send('Hello',
@@ -140,9 +140,9 @@ any sequence, including iterators, that cannot be unpacked as other sequences.
140140

141141
The **arbitrary keyword argument dictionary** is the last way to pass arguments
142142
to functions. If the function requires an undetermined series of named
143-
arguments, it is possible to used the ``**kwargs`` construct. In the function
143+
arguments, it is possible to use the ``**kwargs`` construct. In the function
144144
body, ``kwargs`` will be a dictionary of all the passed named arguments that
145-
have not been caught be other keyword argument in the function signature.
145+
have not been caught by other keyword arguments in the function signature.
146146

147147
The same caution as in the case of *arbitrary argument list* is necessary, for
148148
similar reasons: these powerful techniques are to be used when there is a
@@ -576,7 +576,7 @@ Line Continuations
576576
When a logical line of code is longer than the accepted limit, you need to
577577
split it over multiple physical lines. Python interpreter will join consecutive
578578
lines if the last character of the line is a backslash. This is helpful
579-
sometime but is preferably avoided, because of its fragility: a white space
579+
sometimes but is preferably avoided, because of its fragility: a white space
580580
added to the end of the line, after the backslash, will break the code and may
581581
have unexpected results.
582582

docs/writing/tests.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Some general rules of testing:
2020

2121
- Try hard to make tests that run fast. If one single test needs more than a
2222
few millisecond to run, development will be slowed down or the tests will not
23-
be run as often as desirable. In some cases, test can't be fast because they
23+
be run as often as desirable. In some cases, tests can't be fast because they
2424
need a complex data structure to work on, and this data structure must be
2525
loaded every time the test runs. Keep these heavier tests in a separate test
2626
suite that is run by some scheduled task, and run all other tests as often
@@ -34,10 +34,10 @@ Some general rules of testing:
3434
after. This will give you more confidence that you did not break anything in
3535
the rest of the code.
3636

37-
- It is a good idea to implement a hook that runs all test before pushing code
37+
- It is a good idea to implement a hook that runs all tests before pushing code
3838
to a shared repository.
3939

40-
- If you are in the middle of a development and have to interrupt your work, it
40+
- If you are in the middle of a development session and have to interrupt your work, it
4141
is a good idea to write a broken unit test about what you want to develop next.
4242
When coming back to work, you will have a pointer to where you were and get
4343
faster on tracks.

0 commit comments

Comments
 (0)