Skip to content

Commit 6afbf66

Browse files
committed
DOC: Fix many spelling errors
1 parent ec4aa25 commit 6afbf66

File tree

342 files changed

+1082
-983
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

342 files changed

+1082
-983
lines changed

.github/ISSUE_TEMPLATE/feature_request.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ A clear and concise description of what the problem is. Ex. I'm always frustrate
1313
#### Describe the solution you'd like
1414
A clear and concise description of what you want to happen.
1515

16-
#### Describe alternatives you've considered
17-
A clear and concise description of any alternative solutions or features you've considered.
16+
#### Describe alternatives you have considered
17+
A clear and concise description of any alternative solutions or features you have considered.
1818

1919
#### Additional context
2020
Add any other context about the feature request here.

CONTRIBUTING.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ For a pull request to be accepted, you must meet the below requirements. This gr
3535
Linting
3636
~~~~~~~
3737

38-
Due to the way we have the CI builds set up, the linter won't do anything unless the environmental variable $LINT is set to a truthy value.
38+
Due to the way we have the CI builds set up, the linter will not do anything unless the environmental variable $LINT is set to a truthy value.
3939

4040
- On MacOS/Linux
4141

@@ -46,7 +46,7 @@ Due to the way we have the CI builds set up, the linter won't do anything unless
4646
How to Submit a Pull Request
4747
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4848

49-
So you want to submit a patch to `statsmodels` but aren't too familiar with github? Here are the steps you need to take.
49+
So you want to submit a patch to `statsmodels` but are not too familiar with github? Here are the steps you need to take.
5050

5151
1. `Fork <https://help.github.com/articles/fork-a-repo>`_ the `statsmodels repository <https://github.com/statsmodels/statsmodels>`_ on Github.
5252
2. `Create a new feature branch <https://git-scm.com/book/en/Git-Branching-Basic-Branching-and-Merging>`_. Each branch must be self-contained, with a single new feature or bugfix.

COPYRIGHTS.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ statsmodels contains code or derivative code from several other
55
packages. Some modules also note the author of individual contributions, or
66
author of code that formed the basis for the derived or translated code.
77
The copyright statements for the datasets are attached to the individual
8-
datasets, most datasets are in public domain, and we don't claim any copyright
8+
datasets, most datasets are in public domain, and we do not claim any copyright
99
on any of them.
1010

1111
In the following, we collect copyright statements of code from other packages,

docs/make.bat

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ if errorlevel 9009 (
2828
echo.to the full path of the 'sphinx-build' executable. Alternatively you
2929
echo.may add the Sphinx directory to PATH.
3030
echo.
31-
echo.If you don't have Sphinx installed, grab it from
31+
echo.If you do not have Sphinx installed, grab it from
3232
echo.http://sphinx-doc.org/
3333
exit /b 1
3434
)

docs/source/_static/mktree.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Dual licensed under the MIT and GPL licenses.
55
* This basically means you can use this code however you want for
6-
* free, but don't claim to have written it yourself!
6+
* free, but do not claim to have written it yourself!
77
* Donations always accepted: https://www.JavascriptToolbox.com/donate/
88
*
99
* Please do not link to the .js files on javascripttoolbox.com from
@@ -103,7 +103,7 @@ function convertTrees() {
103103
setDefault("nodeLinkClass","bullet");
104104
setDefault("preProcessTrees",true);
105105
if (preProcessTrees) {
106-
if (!document.createElement) { return; } // Without createElement, we can't do anything
106+
if (!document.createElement) { return; } // Without createElement, we cannot do anything
107107
var uls = document.getElementsByTagName("ul");
108108
if (uls==null) { return; }
109109
var uls_length = uls.length;

docs/source/_templates/autosummary/class.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
{% block methods %}
44
{% if methods %}
5-
.. HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages.
5+
.. HACK -- the point here is that we do not want this to appear in the output, but the autosummary should still generate the pages.
66
.. autosummary::
77
:toctree:
88
{% for item in all_methods %}
@@ -15,7 +15,7 @@
1515

1616
{% block attributes %}
1717
{% if attributes %}
18-
.. HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages.
18+
.. HACK -- the point here is that we do not want this to appear in the output, but the autosummary should still generate the pages.
1919
.. autosummary::
2020
:toctree:
2121
{% for item in all_attributes %}

docs/source/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@
148148
# html_theme = 'default'
149149

150150
if 'htmlhelp' in sys.argv:
151-
# html_theme = 'statsmodels_htmlhelp' #doesn't look nice yet
151+
# html_theme = 'statsmodels_htmlhelp' #does not look nice yet
152152
html_theme = 'default'
153153
print('################# using statsmodels_htmlhelp ############')
154154
else:

docs/source/contrasts.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Patsy: Contrast Coding Systems for categorical variables
77

88
A categorical variable of K categories, or levels, usually enters a regression as a sequence of K-1 dummy variables. This amounts to a linear hypothesis on the level means. That is, each test statistic for these variables amounts to testing whether the mean for that level is statistically significantly different from the mean of the base category. This dummy coding is called Treatment coding in R parlance, and we will follow this convention. There are, however, different coding methods that amount to different sets of linear hypotheses.
99

10-
In fact, the dummy coding is not technically a contrast coding. This is because the dummy variables add to one and are not functionally independent of the model's intercept. On the other hand, a set of *contrasts* for a categorical variable with `k` levels is a set of `k-1` functionally independent linear combinations of the factor level means that are also independent of the sum of the dummy variables. The dummy coding isn't wrong *per se*. It captures all of the coefficients, but it complicates matters when the model assumes independence of the coefficients such as in ANOVA. Linear regression models do not assume independence of the coefficients and thus dummy coding is often the only coding that is taught in this context.
10+
In fact, the dummy coding is not technically a contrast coding. This is because the dummy variables add to one and are not functionally independent of the model's intercept. On the other hand, a set of *contrasts* for a categorical variable with `k` levels is a set of `k-1` functionally independent linear combinations of the factor level means that are also independent of the sum of the dummy variables. The dummy coding is not wrong *per se*. It captures all of the coefficients, but it complicates matters when the model assumes independence of the coefficients such as in ANOVA. Linear regression models do not assume independence of the coefficients and thus dummy coding is often the only coding that is taught in this context.
1111

1212
To have a look at the contrast matrices in Patsy, we will use data from UCLA ATS. First let's load the data.
1313

@@ -72,7 +72,7 @@ Here we used `reference=0`, which implies that the first level, Hispanic, is the
7272
7373
contrast.matrix[hsb2.race-1, :][:20]
7474
75-
This is a bit of a trick, as the `race` category conveniently maps to zero-based indices. If it does not, this conversion happens under the hood, so this won't work in general but nonetheless is a useful exercise to fix ideas. The below illustrates the output using the three contrasts above
75+
This is a bit of a trick, as the `race` category conveniently maps to zero-based indices. If it does not, this conversion happens under the hood, so this will not work in general but nonetheless is a useful exercise to fix ideas. The below illustrates the output using the three contrasts above
7676

7777
.. ipython:: python
7878
@@ -113,7 +113,7 @@ Sum coding compares the mean of the dependent variable for a given level to the
113113
res = mod.fit()
114114
print(res.summary())
115115
116-
This correspons to a parameterization that forces all the coefficients to sum to zero. Notice that the intercept here is the grand mean where the grand mean is the mean of means of the dependent variable by each level.
116+
This corresponds to a parameterization that forces all the coefficients to sum to zero. Notice that the intercept here is the grand mean where the grand mean is the mean of means of the dependent variable by each level.
117117

118118
.. ipython:: python
119119

docs/source/datasets/dataset_proposal.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ Remaining problems:
128128
we want to avoid loading all the data in memory? Can we use memory
129129
mapped arrays ?
130130
- Missing data: I thought about subclassing both record arrays and
131-
masked arrays classes, but I don't know if this is feasable, or even
131+
masked arrays classes, but I do not know if this is feasible, or even
132132
makes sense. I have the feeling that some Data mining software use
133133
Nan (for example, weka seems to use float internally), but this
134134
prevents them from representing integer data.

docs/source/dev/git_notes.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ change history by::
157157
git log --oneline --graph
158158

159159
It pays to take care of things locally before you push them to github. So when
160-
in doubt, don't push. Also see the advice on keeping your history clean in
160+
in doubt, do not push. Also see the advice on keeping your history clean in
161161
:ref:`merge-vs-rebase`.
162162

163163
.. _pull-requests:
@@ -193,7 +193,7 @@ One last thing to note. If there has been a lot of work in upstream/master
193193
since you started your patch, you might want to rebase. However, you can
194194
probably get away with not rebasing if these changes are unrelated to the work
195195
you have done in the `shiny-new-feature` branch. If you can avoid it, then
196-
don't rebase. If you have to, try to do it once and when you are at the end of
196+
do not rebase. If you have to, try to do it once and when you are at the end of
197197
your changes. Read on for some notes on :ref:`merge-vs-rebase`.
198198

199199
Advanced Topics
@@ -221,7 +221,7 @@ the warnings
221221
Namely, **always make a new branch before doing a rebase**. This is good
222222
general advice for working with git. I would also add **never use rebase on
223223
work that has already been published**. If another developer is using your
224-
work, don't rebase!!
224+
work, do not rebase!!
225225

226226
As for merging, **never merge from trunk into your feature branch**. You will,
227227
however, want to check that your work will merge cleanly into trunk. This will
@@ -253,7 +253,7 @@ however. To delete the branch on github, do::
253253
.. Squashing with Rebase
254254
.. ^^^^^^^^^^^^^^^^^^^^^
255255
256-
.. You've made a bunch of incremental commits, but you think they might be better off together as one
256+
.. You have made a bunch of incremental commits, but you think they might be better off together as one
257257
.. commit. You can do this with an interactive rebase. As usual, **only do this when you have local
258258
.. commits. Do not edit the history of changes that have been pushed.**
259259

docs/source/dev/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ greatly helps the job of maintaining and releasing the software a shared effort.
6060
How to Submit a Pull Request
6161
----------------------------
6262

63-
So you want to submit a patch to `statsmodels` but aren't too familiar with
63+
So you want to submit a patch to `statsmodels` but are not too familiar with
6464
github? Here are the steps you need to take.
6565

6666
1. `Fork <https://help.github.com/articles/fork-a-repo/>`_ the

docs/source/dev/maintainer_notes.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ If there are only a few commits, you can rebase to keep a linear history::
3434
git rebase upstream-rw/master
3535

3636
Rebasing will not automatically close the pull request however, if there is one,
37-
so don't forget to do this.
37+
so do not forget to do this.
3838

3939
.. _merging:
4040

docs/source/dev/naming_conventions.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Our directory tree stripped down looks something like::
4141
The submodules are arranged by topic, `discrete` for discrete choice models, or `tsa` for time series
4242
analysis. The submodules that can be import heavy contain an empty __init__.py, except for some testing
4343
code for running tests for the submodules. The namespace to be imported is in `api.py`. That way, we
44-
can import selectively and do not have to import a lot of code that we don't need. Helper functions are
44+
can import selectively and do not have to import a lot of code that we do not need. Helper functions are
4545
usually put in files named `tools.py` and statistical functions, such as statistical tests are placed
4646
in `stattools.py`. Everything has directories for :ref:`tests <testing>`.
4747

@@ -83,7 +83,7 @@ time-series ARMA model we have::
8383
Options
8484
~~~~~~~
8585
We are using similar options in many classes, methods and functions. They
86-
should follow a standardized pattern if they recurr frequently. ::
86+
should follow a standardized pattern if they recur frequently. ::
8787

8888
`missing` ['none', 'drop', 'raise'] define whether inputs are checked for
8989
nans, and how they are treated

docs/source/diagnostic.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ Unknown Change Point
113113
:py:func:`recursive_olsresiduals <statsmodels.stats.diagnostic.recursive_olsresiduals>`
114114
Calculate recursive ols with residuals and cusum test statistic. This is
115115
currently mainly helper function for recursive residual based tests.
116-
However, since it uses recursive updating and doesn't estimate separate
116+
However, since it uses recursive updating and does not estimate separate
117117
problems it should be also quite efficient as expanding OLS function.
118118

119119
missing
@@ -122,7 +122,7 @@ missing
122122
- test on recursive parameter estimates, which are there?
123123

124124

125-
Mutlicollinearity Tests
125+
Multicollinearity Tests
126126
--------------------------------
127127

128128
conditionnum (statsmodels.stattools)

docs/source/faq.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ takes this keyword. You can find more information in the docstring of
3939

4040
.. _build-faq:
4141

42-
Why won't statsmodels build?
42+
Why will not statsmodels build?
4343
----------------------------
4444

4545
Remember that to build, you must have:
@@ -75,7 +75,7 @@ get involved. We accept Pull Requests on our GitHub page for bugfixes and
7575
topics germane to statistics and statistical modeling. In addition, usability
7676
and quality of life enhancements are greatly appreciated as well.
7777

78-
What if my question isn't answered here?
78+
What if my question is not answered here?
7979
----------------------------------------
8080

8181
You may find answers for questions that have not yet been added here on GitHub

docs/source/names_wordlist.txt

+8
Original file line numberDiff line numberDiff line change
@@ -89,3 +89,11 @@ Longley
8989
Koenker
9090
gliptak
9191
Spector
92+
Wes
93+
statawriter
94+
Nonparameteric
95+
prerotated
96+
uniq
97+
exceedance
98+
separatevar
99+

docs/source/nonparametric.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ includes kernel density estimation for univariate and multivariate data,
1111
kernel regression and locally weighted scatterplot smoothing (lowess).
1212

1313
sandbox.nonparametric contains additional functions that are work in progress
14-
or don't have unit tests yet. We are planning to include here nonparametric
14+
or do not have unit tests yet. We are planning to include here nonparametric
1515
density estimators, especially based on kernel or orthogonal polynomials,
1616
smoothers, and tools for nonparametric models and methods in other parts of
1717
statsmodels.

docs/source/plots/graphics_gofplots_qqplot_qqline.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
'''
2-
Import the food expenditure dataset. Plot annual food expendeture on
2+
Import the food expenditure dataset. Plot annual food expenditure on
33
x-axis and household income on y-axis. Use qqline to add regression line
44
into the plot.
55
'''

docs/source/plots/graphics_mosaicplot_mosaic.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
mosaic(data, title='hierarchical index series')
2626
plt.show()
2727

28-
# The third accepted data structureis the np array, for which a very simple
28+
# The third accepted data structure is the np array, for which a very simple
2929
# index will be created.
3030
rand = np.random.random
3131
data = 1+rand((2, 2))

docs/source/plots/graphics_plot_fit_ex.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"""
99

1010
# Load the Statewide Crime data set and perform linear regression with
11-
# 'poverty' and 'hs_grad' as variables and 'muder' as the response
11+
# 'poverty' and 'hs_grad' as variables and 'murder' as the response
1212

1313

1414
import statsmodels.api as sm

docs/source/plots/graphics_regression_regress_exog.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Load the Statewide Crime data set and build a model with regressors
44
including the rate of high school graduation (hs_grad), population in urban
55
areas (urban), households below poverty line (poverty), and single person
6-
households (single). Outcome variable is the muder rate (murder).
6+
households (single). Outcome variable is the murder rate (murder).
77
88
Build a 2 by 2 figure based on poverty showing fitted versus actual murder
99
rate, residuals versus the poverty rate, partial regression plot of poverty,

docs/source/release/old_changes.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ This is a bug-fix release, that affects mainly Big-Endian machines.
5959
*Bug Fixes*
6060

6161
* discrete_model.MNLogit fix summary method
62-
* tsa.filters.hp_filter don't use umfpack on Big-Endian machine (scipy bug)
62+
* tsa.filters.hp_filter do not use umfpack on Big-Endian machine (scipy bug)
6363
* the remaining fixes are in the test suite, either precision problems
6464
on some machines or incorrect testing on Big-Endian machines.
6565

0 commit comments

Comments
 (0)