Skip to content

Commit b812edd

Browse files
authored
docs: fix a few simple typos (#584)
There are small typos in: - docs/sphinxext/ipython_console_highlighting.py - docs/sphinxext/ipython_directive.py - quantecon/compute_fp.py - quantecon/estspec.py - quantecon/filter.py - quantecon/game_theory/pure_nash.py - quantecon/game_theory/tests/test_vertex_enumeration.py - quantecon/game_theory/vertex_enumeration.py - quantecon/lqcontrol.py - quantecon/lss.py - quantecon/markov/tests/test_ddp.py - quantecon/tests/test_ivp.py - quantecon/util/notebooks.py Fixes: - Should read `approximation` rather than `approxmation`. - Should read `response` rather than `reponse`. - Should read `frequencies` rather than `frequences`. - Should read `typically` rather than `typicaly`. - Should read `theorem` rather than `theorm`. - Should read `symmetric` rather than `symetric`. - Should read `representing` rather than `reprensenting`. - Should read `parametric` rather than `parameteric`. - Should read `original` rather than `orignal`. - Should read `equilibrium` rather than `equilibirum`. - Should read `default` rather than `defualt`. - Should read `array` rather than `arrray`. - Should read `covariance` rather than `convariance`. Closes #583
1 parent 708a699 commit b812edd

File tree

13 files changed

+22
-22
lines changed

13 files changed

+22
-22
lines changed

docs/sphinxext/ipython_console_highlighting.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ def get_tokens_unprocessed(self, text):
8181
curcode += line[continue_prompt.end():]
8282
elif output_prompt is not None:
8383
# Use the 'error' token for output. We should probably make
84-
# our own token, but error is typicaly in a bright color like
84+
# our own token, but error is typically in a bright color like
8585
# red, so it works fine for our output prompts.
8686
insertions.append((len(curcode),
8787
[(0, Generic.Error, output_prompt.group())]))

docs/sphinxext/ipython_directive.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
Authors
4747
-------
4848
49-
- John D Hunter: orignal author.
49+
- John D Hunter: original author.
5050
- Fernando Perez: refactoring, documentation, cleanups, port to 0.11.
5151
- VĂĄclavĹ milauer <eudoxos-AT-arcig.cz>: Prompt generalizations.
5252
- Skipper Seabold, refactoring, cleanups, pure python addition

quantecon/compute_fp.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ def compute_fixed_point(T, v, error_tol=1e-3, max_iter=50, verbose=2,
6363
routine. It finds an approximate fixed point of `T`, a point
6464
:math:`v^*` such that :math:`\lVert T(v) - v\rVert \leq
6565
\mathrm{error\_tol}`, provided `T` is a function that satisfies the
66-
assumptions of Brouwer's fixed point theorm, i.e., a continuous
66+
assumptions of Brouwer's fixed point theorem, i.e., a continuous
6767
function that maps a compact and convex set to itself.
6868
6969
Parameters

quantecon/estspec.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,9 @@ def periodogram(x, window=None, window_len=7):
7575
7676
I(w) = \frac{1}{n} \Big[ \sum_{t=0}^{n-1} x_t e^{itw} \Big] ^2
7777
78-
at the Fourier frequences :math:`w_j := \frac{2 \pi j}{n}`,
78+
at the Fourier frequencies :math:`w_j := \frac{2 \pi j}{n}`,
7979
:math:`j = 0, \dots, n - 1`, using the fast Fourier transform. Only the
80-
frequences :math:`w_j` in :math:`[0, \pi]` and corresponding values
80+
frequencies :math:`w_j` in :math:`[0, \pi]` and corresponding values
8181
:math:`I(w_j)` are returned. If a window type is given then smoothing
8282
is performed.
8383
@@ -94,9 +94,9 @@ def periodogram(x, window=None, window_len=7):
9494
Returns
9595
-------
9696
w : array_like(float)
97-
Fourier frequences at which periodogram is evaluated
97+
Fourier frequencies at which periodogram is evaluated
9898
I_w : array_like(float)
99-
Values of periodogram at the Fourier frequences
99+
Values of periodogram at the Fourier frequencies
100100
101101
"""
102102
n = len(x)
@@ -128,9 +128,9 @@ def ar_periodogram(x, window='hanning', window_len=7):
128128
Returns
129129
-------
130130
w : array_like(float)
131-
Fourier frequences at which periodogram is evaluated
131+
Fourier frequencies at which periodogram is evaluated
132132
I_w : array_like(float)
133-
Values of periodogram at the Fourier frequences
133+
Values of periodogram at the Fourier frequencies
134134
135135
"""
136136
# === run regression === #

quantecon/filter.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ def hamilton_filter(data, h, *args):
1313
1414
Parameters
1515
----------
16-
data : arrray or dataframe
16+
data : array or dataframe
1717
h : integer
1818
Time horizon that we are likely to predict incorrectly.
1919
Original paper recommends 2 for annual data, 8 for quarterly data,

quantecon/game_theory/pure_nash.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ def pure_nash_brute(g, tol=None):
3535
[(1, 1)]
3636
3737
If we consider the "Matching Pennies" game, which has no pure nash
38-
equilibirum:
38+
equilibrium:
3939
4040
>>> MP_bimatrix = [[(1, -1), (-1, 1)],
4141
... [(-1, 1), (1, -1)]]

quantecon/game_theory/tests/test_vertex_enumeration.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ def setUp(self):
7979
[(0, 3), (6, 1)]]
8080
g = NormalFormGame(bimatrix)
8181

82-
# Original best reponse polytope for player 0
82+
# Original best response polytope for player 0
8383
vertices_P = np.array([
8484
[0, 0, 0], # 0
8585
[1/3, 0, 0], # a
@@ -103,7 +103,7 @@ def setUp(self):
103103
self.labelings_P = labelings_P[ind]
104104
self.vertices_P = vertices_P[ind]
105105

106-
# Translated best reponse polytope for player 0
106+
# Translated best response polytope for player 0
107107
self.brp0 = _BestResponsePolytope(g.players[1], idx=0)
108108

109109
def test_best_response_polytope(self):

quantecon/game_theory/vertex_enumeration.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ class _BestResponsePolytope:
186186
Dimension of the polytope.
187187
188188
hull : scipy.spatial.ConvexHull
189-
`ConvexHull` instance reprensenting the polar polytope.
189+
`ConvexHull` instance representing the polar polytope.
190190
191191
num_vertices : scalar(int)
192192
Number of the vertices identified by `ConvexHull`.

quantecon/lqcontrol.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ class LQ:
7171
non-negative definite
7272
R : array_like(float)
7373
R is the payoff (or cost) matrix that corresponds with the
74-
state variable x and is n x n. Should be symetric and
74+
state variable x and is n x n. Should be symmetric and
7575
non-negative definite
7676
A : array_like(float)
7777
A is part of the state transition as described above. It should
@@ -93,7 +93,7 @@ class LQ:
9393
Rf : array_like(float), optional(default=None)
9494
Rf is the final (in a finite horizon model) payoff(or cost)
9595
matrix that corresponds with the control variable u and is n x
96-
n. Should be symetric and non-negative definite
96+
n. Should be symmetric and non-negative definite
9797
9898
Attributes
9999
----------

quantecon/lss.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ def replicate(self, T=10, num_reps=100, random_state=None):
245245
def moment_sequence(self):
246246
r"""
247247
Create a generator to calculate the population mean and
248-
variance-convariance matrix for both :math:`x_t` and :math:`y_t`
248+
variance-covariance matrix for both :math:`x_t` and :math:`y_t`
249249
starting at the initial condition (self.mu_0, self.Sigma_0).
250250
Each iteration produces a 4-tuple of items (mu_x, mu_y, Sigma_x,
251251
Sigma_y) for the next period.

0 commit comments

Comments
 (0)