Skip to content

Commit 05e55aa

Browse files
FabioRosadogfyoung
authored andcommitted
DOC: update multi-index term with MultiIndex (#21382)
* Change multi-index to MultiIndex * Revert changes to adverbs, add words to wordlist
1 parent d79203a commit 05e55aa

24 files changed

+88
-84
lines changed

doc/source/basics.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ either match on the *index* or *columns* via the **axis** keyword:
168168
169169
df_orig = df
170170
171-
Furthermore you can align a level of a multi-indexed DataFrame with a Series.
171+
Furthermore you can align a level of a MultiIndexed DataFrame with a Series.
172172

173173
.. ipython:: python
174174
@@ -1034,7 +1034,7 @@ Passing a single function to ``.transform()`` with a ``Series`` will yield a sin
10341034
Transform with multiple functions
10351035
+++++++++++++++++++++++++++++++++
10361036

1037-
Passing multiple functions will yield a column multi-indexed DataFrame.
1037+
Passing multiple functions will yield a column MultiIndexed DataFrame.
10381038
The first level will be the original frame column names; the second level
10391039
will be the names of the transforming functions.
10401040

@@ -1060,7 +1060,7 @@ Passing a dict of functions will allow selective transforming per column.
10601060
10611061
tsdf.transform({'A': np.abs, 'B': lambda x: x+1})
10621062
1063-
Passing a dict of lists will generate a multi-indexed DataFrame with these
1063+
Passing a dict of lists will generate a MultiIndexed DataFrame with these
10641064
selective transforms.
10651065

10661066
.. ipython:: python
@@ -1889,12 +1889,12 @@ faster than sorting the entire Series and calling ``head(n)`` on the result.
18891889
df.nsmallest(5, ['a', 'c'])
18901890
18911891
1892-
.. _basics.multi-index_sorting:
1892+
.. _basics.multiindex_sorting:
18931893

1894-
Sorting by a multi-index column
1895-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1894+
Sorting by a MultiIndex column
1895+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18961896

1897-
You must be explicit about sorting when the column is a multi-index, and fully specify
1897+
You must be explicit about sorting when the column is a MultiIndex, and fully specify
18981898
all levels to ``by``.
18991899

19001900
.. ipython:: python

doc/source/contributing_docstring.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ their use cases, if it is not too generic.
243243
"""
244244
Pivot a row index to columns.
245245
246-
When using a multi-index, a level can be pivoted so each value in
246+
When using a MultiIndex, a level can be pivoted so each value in
247247
the index becomes a column. This is especially useful when a subindex
248248
is repeated for the main index, and data is easier to visualize as a
249249
pivot table.

doc/source/dsintro.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ From a list of dicts
353353
From a dict of tuples
354354
~~~~~~~~~~~~~~~~~~~~~
355355

356-
You can automatically create a multi-indexed frame by passing a tuples
356+
You can automatically create a MultiIndexed frame by passing a tuples
357357
dictionary.
358358

359359
.. ipython:: python

doc/source/ecosystem.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ widely used by institutions such as statistics offices, central banks,
189189
and international organisations. pandaSDMX can expose datasets and related
190190
structural metadata including data flows, code-lists,
191191
and data structure definitions as pandas Series
192-
or multi-indexed DataFrames.
192+
or MultiIndexed DataFrames.
193193

194194
`fredapi <https://github.com/mortada/fredapi>`__
195195
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

doc/source/io.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -2356,7 +2356,7 @@ Read a URL and match a table that contains specific text:
23562356
23572357
Specify a header row (by default ``<th>`` or ``<td>`` elements located within a
23582358
``<thead>`` are used to form the column index, if multiple rows are contained within
2359-
``<thead>`` then a multi-index is created); if specified, the header row is taken
2359+
``<thead>`` then a MultiIndex is created); if specified, the header row is taken
23602360
from the data minus the parsed header elements (``<th>`` elements).
23612361

23622362
.. code-block:: python
@@ -3615,10 +3615,10 @@ defaults to `nan`.
36153615
# we have provided a minimum string column size
36163616
store.root.df_mixed.table
36173617
3618-
Storing Multi-Index DataFrames
3619-
++++++++++++++++++++++++++++++
3618+
Storing MultiIndex DataFrames
3619+
+++++++++++++++++++++++++++++
36203620

3621-
Storing multi-index ``DataFrames`` as tables is very similar to
3621+
Storing MultiIndex ``DataFrames`` as tables is very similar to
36223622
storing/selecting from homogeneous index ``DataFrames``.
36233623

36243624
.. ipython:: python

doc/source/merging.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -1085,12 +1085,12 @@ As you can see, this drops any rows where there was no match.
10851085

10861086
.. _merging.join_on_mi:
10871087

1088-
Joining a single Index to a Multi-index
1089-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1088+
Joining a single Index to a MultiIndex
1089+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10901090

1091-
You can join a singly-indexed ``DataFrame`` with a level of a multi-indexed ``DataFrame``.
1091+
You can join a singly-indexed ``DataFrame`` with a level of a MultiIndexed ``DataFrame``.
10921092
The level will match on the name of the index of the singly-indexed frame against
1093-
a level name of the multi-indexed frame.
1093+
a level name of the MultiIndexed frame.
10941094

10951095
.. ipython:: python
10961096
@@ -1130,8 +1130,8 @@ This is equivalent but less verbose and more memory efficient / faster than this
11301130
labels=['left', 'right'], vertical=False);
11311131
plt.close('all');
11321132
1133-
Joining with two multi-indexes
1134-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1133+
Joining with two MultiIndexes
1134+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11351135

11361136
This is not implemented via ``join`` at-the-moment, however it can be done using
11371137
the following code.

doc/source/release.rst

+24-24
Original file line numberDiff line numberDiff line change
@@ -2174,7 +2174,7 @@ Highlights include:
21742174
- SQL interfaces updated to use ``sqlalchemy``, see :ref:`here<whatsnew_0140.sql>`.
21752175
- Display interface changes, see :ref:`here<whatsnew_0140.display>`
21762176
- MultiIndexing using Slicers, see :ref:`here<whatsnew_0140.slicers>`.
2177-
- Ability to join a singly-indexed DataFrame with a multi-indexed DataFrame, see :ref:`here <merging.join_on_mi>`
2177+
- Ability to join a singly-indexed DataFrame with a MultiIndexed DataFrame, see :ref:`here <merging.join_on_mi>`
21782178
- More consistency in groupby results and more flexible groupby specifications, see :ref:`here<whatsnew_0140.groupby>`
21792179
- Holiday calendars are now supported in ``CustomBusinessDay``, see :ref:`here <timeseries.holiday>`
21802180
- Several improvements in plotting functions, including: hexbin, area and pie plots, see :ref:`here<whatsnew_0140.plotting>`.
@@ -2384,8 +2384,8 @@ Bug Fixes
23842384
- Bug in merging ``timedelta`` dtypes (:issue:`5695`)
23852385
- Bug in plotting.scatter_matrix function. Wrong alignment among diagonal
23862386
and off-diagonal plots, see (:issue:`5497`).
2387-
- Regression in Series with a multi-index via ix (:issue:`6018`)
2388-
- Bug in Series.xs with a multi-index (:issue:`6018`)
2387+
- Regression in Series with a MultiIndex via ix (:issue:`6018`)
2388+
- Bug in Series.xs with a MultiIndex (:issue:`6018`)
23892389
- Bug in Series construction of mixed type with datelike and an integer (which should result in
23902390
object type and not automatic conversion) (:issue:`6028`)
23912391
- Possible segfault when chained indexing with an object array under NumPy 1.7.1 (:issue:`6026`, :issue:`6056`)
@@ -2409,10 +2409,10 @@ Bug Fixes
24092409
- Fixed a bug in ``query``/``eval`` during lexicographic string comparisons (:issue:`6155`).
24102410
- Fixed a bug in ``query`` where the index of a single-element ``Series`` was
24112411
being thrown away (:issue:`6148`).
2412-
- Bug in ``HDFStore`` on appending a dataframe with multi-indexed columns to
2412+
- Bug in ``HDFStore`` on appending a dataframe with MultiIndexed columns to
24132413
an existing table (:issue:`6167`)
24142414
- Consistency with dtypes in setting an empty DataFrame (:issue:`6171`)
2415-
- Bug in selecting on a multi-index ``HDFStore`` even in the presence of under
2415+
- Bug in selecting on a MultiIndex ``HDFStore`` even in the presence of under
24162416
specified column spec (:issue:`6169`)
24172417
- Bug in ``nanops.var`` with ``ddof=1`` and 1 elements would sometimes return ``inf``
24182418
rather than ``nan`` on some platforms (:issue:`6136`)
@@ -2659,8 +2659,8 @@ API Changes
26592659
- the ``format`` keyword now replaces the ``table`` keyword; allowed values
26602660
are ``fixed(f)|table(t)`` the ``Storer`` format has been renamed to
26612661
``Fixed``
2662-
- a column multi-index will be recreated properly (:issue:`4710`); raise on
2663-
trying to use a multi-index with data_columns on the same axis
2662+
- a column MultiIndex will be recreated properly (:issue:`4710`); raise on
2663+
trying to use a MultiIndex with data_columns on the same axis
26642664
- ``select_as_coordinates`` will now return an ``Int64Index`` of the
26652665
resultant selection set
26662666
- support ``timedelta64[ns]`` as a serialization type (:issue:`3577`)
@@ -2932,7 +2932,7 @@ Bug Fixes
29322932
- A zero length series written in Fixed format not deserializing properly.
29332933
(:issue:`4708`)
29342934
- Fixed decoding perf issue on pyt3 (:issue:`5441`)
2935-
- Validate levels in a multi-index before storing (:issue:`5527`)
2935+
- Validate levels in a MultiIndex before storing (:issue:`5527`)
29362936
- Correctly handle ``data_columns`` with a Panel (:issue:`5717`)
29372937
- Fixed bug in tslib.tz_convert(vals, tz1, tz2): it could raise IndexError
29382938
exception while trying to access trans[pos + 1] (:issue:`4496`)
@@ -2995,7 +2995,7 @@ Bug Fixes
29952995
alignment (:issue:`3777`)
29962996
- frozenset objects now raise in the ``Series`` constructor (:issue:`4482`,
29972997
:issue:`4480`)
2998-
- Fixed issue with sorting a duplicate multi-index that has multiple dtypes
2998+
- Fixed issue with sorting a duplicate MultiIndex that has multiple dtypes
29992999
(:issue:`4516`)
30003000
- Fixed bug in ``DataFrame.set_values`` which was causing name attributes to
30013001
be lost when expanding the index. (:issue:`3742`, :issue:`4039`)
@@ -3042,11 +3042,11 @@ Bug Fixes
30423042
(:issue:`4328`)
30433043
- Bug with Series indexing not raising an error when the right-hand-side has
30443044
an incorrect length (:issue:`2702`)
3045-
- Bug in multi-indexing with a partial string selection as one part of a
3045+
- Bug in MultiIndexing with a partial string selection as one part of a
30463046
MultIndex (:issue:`4758`)
30473047
- Bug with reindexing on the index with a non-unique index will now raise
30483048
``ValueError`` (:issue:`4746`)
3049-
- Bug in setting with ``loc/ix`` a single indexer with a multi-index axis and
3049+
- Bug in setting with ``loc/ix`` a single indexer with a MultiIndex axis and
30503050
a NumPy array, related to (:issue:`3777`)
30513051
- Bug in concatenation with duplicate columns across dtypes not merging with
30523052
axis=0 (:issue:`4771`, :issue:`4975`)
@@ -3117,7 +3117,7 @@ Bug Fixes
31173117
- Make sure series-series boolean comparisons are label based (:issue:`4947`)
31183118
- Bug in multi-level indexing with a Timestamp partial indexer
31193119
(:issue:`4294`)
3120-
- Tests/fix for multi-index construction of an all-nan frame (:issue:`4078`)
3120+
- Tests/fix for MultiIndex construction of an all-nan frame (:issue:`4078`)
31213121
- Fixed a bug where :func:`~pandas.read_html` wasn't correctly inferring
31223122
values of tables with commas (:issue:`5029`)
31233123
- Fixed a bug where :func:`~pandas.read_html` wasn't providing a stable
@@ -3174,7 +3174,7 @@ Bug Fixes
31743174
- Fixed segfault in C parser caused by passing more names than columns in
31753175
the file. (:issue:`5156`)
31763176
- Fix ``Series.isin`` with date/time-like dtypes (:issue:`5021`)
3177-
- C and Python Parser can now handle the more common multi-index column
3177+
- C and Python Parser can now handle the more common MultiIndex column
31783178
format which doesn't have a row for index names (:issue:`4702`)
31793179
- Bug when trying to use an out-of-bounds date as an object dtype
31803180
(:issue:`5312`)
@@ -3199,7 +3199,7 @@ Bug Fixes
31993199
- performance improvements in ``isnull`` on larger size pandas objects
32003200
- Fixed various setitem with 1d ndarray that does not have a matching
32013201
length to the indexer (:issue:`5508`)
3202-
- Bug in getitem with a multi-index and ``iloc`` (:issue:`5528`)
3202+
- Bug in getitem with a MultiIndex and ``iloc`` (:issue:`5528`)
32033203
- Bug in delitem on a Series (:issue:`5542`)
32043204
- Bug fix in apply when using custom function and objects are not mutated (:issue:`5545`)
32053205
- Bug in selecting from a non-unique index with ``loc`` (:issue:`5553`)
@@ -3208,7 +3208,7 @@ Bug Fixes
32083208
- Bug in repeated indexing of object with resultant non-unique index (:issue:`5678`)
32093209
- Bug in fillna with Series and a passed series/dict (:issue:`5703`)
32103210
- Bug in groupby transform with a datetime-like grouper (:issue:`5712`)
3211-
- Bug in multi-index selection in PY3 when using certain keys (:issue:`5725`)
3211+
- Bug in MultiIndex selection in PY3 when using certain keys (:issue:`5725`)
32123212
- Row-wise concat of differing dtypes failing in certain cases (:issue:`5754`)
32133213

32143214
pandas 0.12.0
@@ -3229,14 +3229,14 @@ New Features
32293229
- Added module for reading and writing Stata files: pandas.io.stata (:issue:`1512`)
32303230
includes ``to_stata`` DataFrame method, and a ``read_stata`` top-level reader
32313231
- Added support for writing in ``to_csv`` and reading in ``read_csv``,
3232-
multi-index columns. The ``header`` option in ``read_csv`` now accepts a
3232+
MultiIndex columns. The ``header`` option in ``read_csv`` now accepts a
32333233
list of the rows from which to read the index. Added the option,
32343234
``tupleize_cols`` to provide compatibility for the pre 0.12 behavior of
3235-
writing and reading multi-index columns via a list of tuples. The default in
3235+
writing and reading MultiIndex columns via a list of tuples. The default in
32363236
0.12 is to write lists of tuples and *not* interpret list of tuples as a
3237-
multi-index column.
3237+
MultiIndex column.
32383238
Note: The default value will change in 0.12 to make the default *to* write and
3239-
read multi-index columns in the new format. (:issue:`3571`, :issue:`1651`, :issue:`3141`)
3239+
read MultiIndex columns in the new format. (:issue:`3571`, :issue:`1651`, :issue:`3141`)
32403240
- Add iterator to ``Series.str`` (:issue:`3638`)
32413241
- ``pd.set_option()`` now allows N option, value pairs (:issue:`3667`).
32423242
- Added keyword parameters for different types of scatter_matrix subplots
@@ -3447,7 +3447,7 @@ Bug Fixes
34473447
- Fixed bug with ``Panel.transpose`` argument aliases (:issue:`3556`)
34483448
- Fixed platform bug in ``PeriodIndex.take`` (:issue:`3579`)
34493449
- Fixed bud in incorrect conversion of datetime64[ns] in ``combine_first`` (:issue:`3593`)
3450-
- Fixed bug in reset_index with ``NaN`` in a multi-index (:issue:`3586`)
3450+
- Fixed bug in reset_index with ``NaN`` in a MultiIndex (:issue:`3586`)
34513451
- ``fillna`` methods now raise a ``TypeError`` when the ``value`` parameter
34523452
is a ``list`` or ``tuple``.
34533453
- Fixed bug where a time-series was being selected in preference to an actual column name
@@ -3480,7 +3480,7 @@ Bug Fixes
34803480
their first argument (:issue:`3702`)
34813481
- Fix file tokenization error with \r delimiter and quoted fields (:issue:`3453`)
34823482
- Groupby transform with item-by-item not upcasting correctly (:issue:`3740`)
3483-
- Incorrectly read a HDFStore multi-index Frame with a column specification (:issue:`3748`)
3483+
- Incorrectly read a HDFStore MultiIndex Frame with a column specification (:issue:`3748`)
34843484
- ``read_html`` now correctly skips tests (:issue:`3741`)
34853485
- PandasObjects raise TypeError when trying to hash (:issue:`3882`)
34863486
- Fix incorrect arguments passed to concat that are not list-like (e.g. concat(df1,df2)) (:issue:`3481`)
@@ -3497,7 +3497,7 @@ Bug Fixes
34973497
- csv parsers would loop infinitely if ``iterator=True`` but no ``chunksize`` was
34983498
specified (:issue:`3967`), Python parser failing with ``chunksize=1``
34993499
- Fix index name not propagating when using ``shift``
3500-
- Fixed dropna=False being ignored with multi-index stack (:issue:`3997`)
3500+
- Fixed dropna=False being ignored with MultiIndex stack (:issue:`3997`)
35013501
- Fixed flattening of columns when renaming MultiIndex columns DataFrame (:issue:`4004`)
35023502
- Fix ``Series.clip`` for datetime series. NA/NaN threshold values will now throw ValueError (:issue:`3996`)
35033503
- Fixed insertion issue into DataFrame, after rename (:issue:`4032`)
@@ -3521,7 +3521,7 @@ Bug Fixes
35213521
iterated over when regex=False (:issue:`4115`)
35223522
- Fixed bug in ``convert_objects(convert_numeric=True)`` where a mixed numeric and
35233523
object Series/Frame was not converting properly (:issue:`4119`)
3524-
- Fixed bugs in multi-index selection with column multi-index and duplicates
3524+
- Fixed bugs in MultiIndex selection with column MultiIndex and duplicates
35253525
(:issue:`4145`, :issue:`4146`)
35263526
- Fixed bug in the parsing of microseconds when using the ``format``
35273527
argument in ``to_datetime`` (:issue:`4152`)
@@ -3830,7 +3830,7 @@ Improvements to existing features
38303830

38313831
- ``HDFStore``
38323832

3833-
- enables storing of multi-index dataframes (closes :issue:`1277`)
3833+
- enables storing of MultiIndex dataframes (closes :issue:`1277`)
38343834
- support data column indexing and selection, via ``data_columns`` keyword
38353835
in append
38363836
- support write chunking to reduce memory footprint, via ``chunksize``

doc/source/spelling_wordlist.txt

+4
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ ga
88
fe
99
reindexed
1010
automagic
11+
closedness
12+
ae
13+
arbitrarly
14+
losslessly
1115
Histogramming
1216
histogramming
1317
concat

doc/source/whatsnew/v0.10.0.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,7 @@ Updated PyTables Support
370370
df1.get_dtype_counts()
371371

372372
- performance improvements on table writing
373-
- support for arbitrary indexed dimensions
373+
- support for arbitrarly indexed dimensions
374374
- ``SparseSeries`` now has a ``density`` property (:issue:`2384`)
375375
- enable ``Series.str.strip/lstrip/rstrip`` methods to take an input argument
376376
to strip arbitrary characters (:issue:`2411`)

doc/source/whatsnew/v0.10.1.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ columns, this is equivalent to passing a
9393

9494
store.select('df',columns = ['A','B'])
9595

96-
``HDFStore`` now serializes multi-index dataframes when appending tables.
96+
``HDFStore`` now serializes MultiIndex dataframes when appending tables.
9797

9898
.. ipython:: python
9999

doc/source/whatsnew/v0.12.0.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This is a major release from 0.11.0 and includes several new features and
77
enhancements along with a large number of bug fixes.
88

99
Highlights include a consistent I/O API naming scheme, routines to read html,
10-
write multi-indexes to csv files, read & write STATA data files, read & write JSON format
10+
write MultiIndexes to csv files, read & write STATA data files, read & write JSON format
1111
files, Python 3 support for ``HDFStore``, filtering of groupby expressions via ``filter``, and a
1212
revamped ``replace`` routine that accepts regular expressions.
1313

0 commit comments

Comments
 (0)