Skip to content

Commit e0a0242

Browse files
Merge pull request pandas-dev#7745 from lexual/docs_fixes
Docs fixes
2 parents c79094c + 5406926 commit e0a0242

18 files changed

+115
-115
lines changed

doc/README.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ Some other important things to know about the docs:
3333
itself and the docs in this folder ``pandas/doc/``.
3434

3535
The docstrings provide a clear explanation of the usage of the individual
36-
functions, while the documentation in this filder consists of tutorial-like
37-
overviews per topic together with some other information (whatsnew,
36+
functions, while the documentation in this folder consists of tutorial-like
37+
overviews per topic together with some other information (what's new,
3838
installation, etc).
3939

4040
- The docstrings follow the **Numpy Docstring Standard** which is used widely
@@ -56,7 +56,7 @@ Some other important things to know about the docs:
5656
x = 2
5757
x**3
5858

59-
will be renderd as
59+
will be rendered as
6060

6161
::
6262

@@ -66,7 +66,7 @@ Some other important things to know about the docs:
6666
Out[2]: 8
6767

6868
This means that almost all code examples in the docs are always run (and the
69-
ouptut saved) during the doc build. This way, they will always be up to date,
69+
output saved) during the doc build. This way, they will always be up to date,
7070
but it makes the doc building a bit more complex.
7171

7272

@@ -135,12 +135,12 @@ If you want to do a full clean build, do::
135135

136136
Staring with 0.13.1 you can tell ``make.py`` to compile only a single section
137137
of the docs, greatly reducing the turn-around time for checking your changes.
138-
You will be prompted to delete unrequired `.rst` files, since the last commited
139-
version can always be restored from git.
138+
You will be prompted to delete `.rst` files that aren't required, since the
139+
last committed version can always be restored from git.
140140

141141
::
142142

143-
#omit autosummary and api section
143+
#omit autosummary and API section
144144
python make.py clean
145145
python make.py --no-api
146146

doc/source/10min.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ For slicing columns explicitly
260260
261261
df.iloc[:,1:3]
262262
263-
For getting a value explicity
263+
For getting a value explicitly
264264

265265
.. ipython:: python
266266

doc/source/basics.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ General DataFrame Combine
346346
The ``combine_first`` method above calls the more general DataFrame method
347347
``combine``. This method takes another DataFrame and a combiner function,
348348
aligns the input DataFrame and then passes the combiner function pairs of
349-
Series (ie, columns whose names are the same).
349+
Series (i.e., columns whose names are the same).
350350

351351
So, for instance, to reproduce ``combine_first`` as above:
352352

@@ -1461,7 +1461,7 @@ from the current type (say ``int`` to ``float``)
14611461
df3.dtypes
14621462
14631463
The ``values`` attribute on a DataFrame return the *lower-common-denominator* of the dtypes, meaning
1464-
the dtype that can accommodate **ALL** of the types in the resulting homogenous dtyped numpy array. This can
1464+
the dtype that can accommodate **ALL** of the types in the resulting homogeneous dtyped numpy array. This can
14651465
force some *upcasting*.
14661466

14671467
.. ipython:: python

doc/source/cookbook.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -499,7 +499,7 @@ The :ref:`HDFStores <io.hdf5>` docs
499499
`Merging on-disk tables with millions of rows
500500
<http://stackoverflow.com/questions/14614512/merging-two-tables-with-millions-of-rows-in-python/14617925#14617925>`__
501501

502-
Deduplicating a large store by chunks, essentially a recursive reduction operation. Shows a function for taking in data from
502+
De-duplicating a large store by chunks, essentially a recursive reduction operation. Shows a function for taking in data from
503503
csv file and creating a store by chunks, with date parsing as well.
504504
`See here
505505
<http://stackoverflow.com/questions/16110252/need-to-compare-very-large-files-around-1-5gb-in-python/16110391#16110391>`__

doc/source/dsintro.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ provided. The value will be repeated to match the length of **index**
118118
Series is ndarray-like
119119
~~~~~~~~~~~~~~~~~~~~~~
120120

121-
``Series`` acts very similary to a ``ndarray``, and is a valid argument to most NumPy functions.
121+
``Series`` acts very similarly to a ``ndarray``, and is a valid argument to most NumPy functions.
122122
However, things like slicing also slice the index.
123123

124124
.. ipython :: python
@@ -474,7 +474,7 @@ DataFrame:
474474
475475
For a more exhaustive treatment of more sophisticated label-based indexing and
476476
slicing, see the :ref:`section on indexing <indexing>`. We will address the
477-
fundamentals of reindexing / conforming to new sets of lables in the
477+
fundamentals of reindexing / conforming to new sets of labels in the
478478
:ref:`section on reindexing <basics.reindexing>`.
479479

480480
Data alignment and arithmetic
@@ -892,7 +892,7 @@ Slicing
892892
~~~~~~~
893893

894894
Slicing works in a similar manner to a Panel. ``[]`` slices the first dimension.
895-
``.ix`` allows you to slice abitrarily and get back lower dimensional objects
895+
``.ix`` allows you to slice arbitrarily and get back lower dimensional objects
896896

897897
.. ipython:: python
898898

doc/source/enhancingperf.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -553,7 +553,7 @@ standard Python.
553553
:func:`pandas.eval` Parsers
554554
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
555555

556-
There are two different parsers and and two different engines you can use as
556+
There are two different parsers and two different engines you can use as
557557
the backend.
558558

559559
The default ``'pandas'`` parser allows a more intuitive syntax for expressing

doc/source/faq.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ Frequency conversion
144144

145145
Frequency conversion is implemented using the ``resample`` method on TimeSeries
146146
and DataFrame objects (multiple time series). ``resample`` also works on panels
147-
(3D). Here is some code that resamples daily data to montly:
147+
(3D). Here is some code that resamples daily data to monthly:
148148

149149
.. ipython:: python
150150

doc/source/gotchas.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ Why not make NumPy like R?
183183
~~~~~~~~~~~~~~~~~~~~~~~~~~
184184

185185
Many people have suggested that NumPy should simply emulate the ``NA`` support
186-
present in the more domain-specific statistical programming langauge `R
186+
present in the more domain-specific statistical programming language `R
187187
<http://r-project.org>`__. Part of the reason is the NumPy type hierarchy:
188188

189189
.. csv-table::
@@ -500,7 +500,7 @@ parse HTML tables in the top-level pandas io function ``read_html``.
500500
molasses. However consider the fact that many tables on the web are not
501501
big enough for the parsing algorithm runtime to matter. It is more
502502
likely that the bottleneck will be in the process of reading the raw
503-
text from the url over the web, i.e., IO (input-output). For very large
503+
text from the URL over the web, i.e., IO (input-output). For very large
504504
tables, this might not be true.
505505

506506
**Issues with using** |Anaconda|_

doc/source/groupby.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -969,7 +969,7 @@ Regroup columns of a DataFrame according to their sum, and sum the aggregated on
969969
df.groupby(df.sum(), axis=1).sum()
970970
971971
972-
Returning a Series to propogate names
972+
Returning a Series to propagate names
973973
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
974974

975975
Group DataFrame columns, compute a set of metrics and return a named Series.

doc/source/indexing.rst

+12-12
Original file line numberDiff line numberDiff line change
@@ -88,10 +88,10 @@ of multi-axis indexing.
8888
See more at :ref:`Selection by Position <indexing.integer>`
8989

9090
- ``.ix`` supports mixed integer and label based access. It is primarily label
91-
based, but will fallback to integer positional access. ``.ix`` is the most
91+
based, but will fall back to integer positional access. ``.ix`` is the most
9292
general and will support any of the inputs to ``.loc`` and ``.iloc``, as well
9393
as support for floating point label schemes. ``.ix`` is especially useful
94-
when dealing with mixed positional and label based hierarchial indexes.
94+
when dealing with mixed positional and label based hierarchical indexes.
9595
As using integer slices with ``.ix`` have different behavior depending on
9696
whether the slice is interpreted as position based or label based, it's
9797
usually better to be explicit and use ``.iloc`` or ``.loc``.
@@ -230,7 +230,7 @@ new column.
230230
- The ``Series/Panel`` accesses are available starting in 0.13.0.
231231

232232
If you are using the IPython environment, you may also use tab-completion to
233-
see these accessable attributes.
233+
see these accessible attributes.
234234

235235
Slicing ranges
236236
--------------
@@ -328,7 +328,7 @@ For getting values with a boolean array
328328
df1.loc['a']>0
329329
df1.loc[:,df1.loc['a']>0]
330330
331-
For getting a value explicity (equiv to deprecated ``df.get_value('a','A')``)
331+
For getting a value explicitly (equiv to deprecated ``df.get_value('a','A')``)
332332

333333
.. ipython:: python
334334
@@ -415,7 +415,7 @@ For getting a cross section using an integer position (equiv to ``df.xs(1)``)
415415
416416
df1.iloc[1]
417417
418-
There is one signficant departure from standard python/numpy slicing semantics.
418+
There is one significant departure from standard python/numpy slicing semantics.
419419
python/numpy allow slicing past the end of an array without an associated error.
420420

421421
.. ipython:: python
@@ -494,7 +494,7 @@ out what you're asking for. If you only want to access a scalar value, the
494494
fastest way is to use the ``at`` and ``iat`` methods, which are implemented on
495495
all of the data structures.
496496

497-
Similary to ``loc``, ``at`` provides **label** based scalar lookups, while, ``iat`` provides **integer** based lookups analagously to ``iloc``
497+
Similarly to ``loc``, ``at`` provides **label** based scalar lookups, while, ``iat`` provides **integer** based lookups analogously to ``iloc``
498498

499499
.. ipython:: python
500500
@@ -643,7 +643,7 @@ To return a Series of the same shape as the original
643643
644644
s.where(s > 0)
645645
646-
Selecting values from a DataFrame with a boolean critierion now also preserves
646+
Selecting values from a DataFrame with a boolean criterion now also preserves
647647
input data shape. ``where`` is used under the hood as the implementation.
648648
Equivalent is ``df.where(df < 0)``
649649

@@ -690,7 +690,7 @@ without creating a copy:
690690
**alignment**
691691

692692
Furthermore, ``where`` aligns the input boolean condition (ndarray or DataFrame),
693-
such that partial selection with setting is possible. This is analagous to
693+
such that partial selection with setting is possible. This is analogous to
694694
partial setting via ``.ix`` (but on the contents rather than the axis labels)
695695

696696
.. ipython:: python
@@ -756,7 +756,7 @@ between the values of columns ``a`` and ``c``. For example:
756756
# query
757757
df.query('(a < b) & (b < c)')
758758
759-
Do the same thing but fallback on a named index if there is no column
759+
Do the same thing but fall back on a named index if there is no column
760760
with the name ``a``.
761761

762762
.. ipython:: python
@@ -899,7 +899,7 @@ The ``in`` and ``not in`` operators
899899
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
900900

901901
:meth:`~pandas.DataFrame.query` also supports special use of Python's ``in`` and
902-
``not in`` comparison operators, providing a succint syntax for calling the
902+
``not in`` comparison operators, providing a succinct syntax for calling the
903903
``isin`` method of a ``Series`` or ``DataFrame``.
904904

905905
.. ipython:: python
@@ -1416,7 +1416,7 @@ faster, and allows one to index *both* axes if so desired.
14161416
Why does the assignment when using chained indexing fail!
14171417
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14181418
1419-
So, why does this show the ``SettingWithCopy`` warning / and possibly not work when you do chained indexing and assignement:
1419+
So, why does this show the ``SettingWithCopy`` warning / and possibly not work when you do chained indexing and assignment:
14201420
14211421
.. code-block:: python
14221422
@@ -2149,7 +2149,7 @@ metadata, like the index ``name`` (or, for ``MultiIndex``, ``levels`` and
21492149

21502150
You can use the ``rename``, ``set_names``, ``set_levels``, and ``set_labels``
21512151
to set these attributes directly. They default to returning a copy; however,
2152-
you can specify ``inplace=True`` to have the data change inplace.
2152+
you can specify ``inplace=True`` to have the data change in place.
21532153

21542154
.. ipython:: python
21552155

0 commit comments

Comments
 (0)