Skip to content

Commit 42e04ee

Browse files
committed
DOC: minor documenation changes
1 parent 39923f6 commit 42e04ee

File tree

3 files changed

+17
-19
lines changed

3 files changed

+17
-19
lines changed

doc/source/computation.rst

+4-6
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ All of these are currently computed using pairwise complete observations.
115115
.. note::
116116

117117
Please see the :ref:`caveats <computation.covariance.caveats>` associated
118-
with this method of calculating correlation matrices in the
118+
with this method of calculating correlation matrices in the
119119
:ref:`covariance section <computation.covariance>`.
120120

121121
.. ipython:: python
@@ -228,7 +228,6 @@ otherwise they can be found in :mod:`pandas.stats.moments`.
228228
``rolling_apply``, Generic apply
229229
``rolling_cov``, Unbiased covariance (binary)
230230
``rolling_corr``, Correlation (binary)
231-
``rolling_corr_pairwise``, Pairwise correlation of DataFrame columns
232231
``rolling_window``, Moving window function
233232

234233
Generally these methods all have the same interface. The binary operators
@@ -392,7 +391,7 @@ can even be omitted:
392391
correls[df.index[-50]]
393392
394393
.. note::
395-
394+
396395
Prior to version 0.14 this was available through ``rolling_corr_pairwise``
397396
which is now simply syntactic sugar for calling ``rolling_corr(...,
398397
pairwise=True)`` and deprecated. This is likely to be removed in a future
@@ -445,7 +444,6 @@ Like the ``rolling_`` functions, the following methods are included in the
445444
``expanding_apply``, Generic apply
446445
``expanding_cov``, Unbiased covariance (binary)
447446
``expanding_corr``, Correlation (binary)
448-
``expanding_corr_pairwise``, Pairwise correlation of DataFrame columns
449447

450448
Aside from not having a ``window`` parameter, these functions have the same
451449
interfaces as their ``rolling_`` counterpart. Like above, the parameters they
@@ -511,7 +509,7 @@ directly, it's easier to think about either the **span**, **center of mass
511509
\end{cases}
512510
513511
.. note::
514-
512+
515513
the equation above is sometimes written in the form
516514

517515
.. math::
@@ -524,7 +522,7 @@ You can pass one of the three to these functions but not more. **Span**
524522
corresponds to what is commonly called a "20-day EW moving average" for
525523
example. **Center of mass** has a more physical interpretation. For example,
526524
**span** = 20 corresponds to **com** = 9.5. **Halflife** is the period of
527-
time for the exponential weight to reduce to one half. Here is the list of
525+
time for the exponential weight to reduce to one half. Here is the list of
528526
functions available:
529527

530528
.. csv-table::

doc/source/release.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -106,10 +106,10 @@ API Changes
106106
it with the ``'@'`` prefix.
107107
- You can have an expression like ``df.query('@a < a')`` with no complaints
108108
from ``pandas`` about ambiguity of the name ``a``.
109+
- The top-level :func:`pandas.eval` function does not allow you use the
110+
``'@'`` prefix and provides you with an error message telling you so.
111+
- ``NameResolutionError`` was removed because it isn't necessary anymore.
109112

110-
- The top-level :func:`pandas.eval` function does not allow you use the
111-
``'@'`` prefix and provides you with an error message telling you so.
112-
- ``NameResolutionError`` was removed because it isn't necessary anymore.
113113
- ``concat`` will now concatenate mixed Series and DataFrames using the Series name
114114
or numbering columns as needed (:issue:`2385`)
115115
- Slicing and advanced/boolean indexing operations on ``Index`` classes will no
@@ -204,7 +204,7 @@ Improvements to existing features
204204
- Support passing ``encoding`` with xlwt (:issue:`3710`)
205205
- Performance improvement when converting ``DatetimeIndex`` to floating ordinals
206206
using ``DatetimeConverter`` (:issue:`6636`)
207-
- Performance improvement for ``DataFrame.shift`` (:issue: `5609`)
207+
- Performance improvement for ``DataFrame.shift`` (:issue:`5609`)
208208

209209
.. _release.bug_fixes-0.14.0:
210210

doc/source/v0.14.0.txt

+9-9
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ API changes
1818

1919
- ``read_excel`` uses 0 as the default sheet (:issue:`6573`)
2020
- ``iloc`` will now accept out-of-bounds indexers for slices, e.g. a value that exceeds the length of the object being
21-
indexed. These will be excluded. This will make pandas conform more with pandas/numpy indexing of out-of-bounds
21+
indexed. These will be excluded. This will make pandas conform more with python/numpy indexing of out-of-bounds
2222
values. A single indexer / list of indexers that is out-of-bounds will still raise
2323
``IndexError`` (:issue:`6296`, :issue:`6299`). This could result in an empty axis (e.g. an empty DataFrame being returned)
2424

@@ -108,10 +108,10 @@ API changes
108108
it with the ``'@'`` prefix.
109109
- You can have an expression like ``df.query('@a < a')`` with no complaints
110110
from ``pandas`` about ambiguity of the name ``a``.
111+
- The top-level :func:`pandas.eval` function does not allow you use the
112+
``'@'`` prefix and provides you with an error message telling you so.
113+
- ``NameResolutionError`` was removed because it isn't necessary anymore.
111114

112-
- The top-level :func:`pandas.eval` function does not allow you use the
113-
``'@'`` prefix and provides you with an error message telling you so.
114-
- ``NameResolutionError`` was removed because it isn't necessary anymore.
115115
- ``concat`` will now concatenate mixed Series and DataFrames using the Series name
116116
or numbering columns as needed (:issue:`2385`). See :ref:`the docs <merging.mixed_ndims>`
117117
- Slicing and advanced/boolean indexing operations on ``Index`` classes will no
@@ -181,7 +181,7 @@ API changes
181181

182182
- `position`: Specify relative alignments for bar plot layout. From 0 (left/bottom-end) to 1(right/top-end). Default is 0.5 (center). (:issue:`6604`)
183183

184-
Because of the default `align` value changes, coordinates of bar plots are now located on integer values (0.0, 1.0, 2.0 ...). This is intended to make bar plot be located on the same coodinates as line plot. However, bar plot may differs unexpectedly when you manually adjust the bar location or drawing area, such as using `set_xlim`, `set_ylim`, etc. In this cases, please modify your script to meet with new coordinates.
184+
Because of the default `align` value changes, coordinates of bar plots are now located on integer values (0.0, 1.0, 2.0 ...). This is intended to make bar plot be located on the same coodinates as line plot. However, bar plot may differs unexpectedly when you manually adjust the bar location or drawing area, such as using `set_xlim`, `set_ylim`, etc. In this cases, please modify your script to meet with new coordinates.
185185

186186
- ``pairwise`` keyword was added to the statistical moment functions
187187
``rolling_cov``, ``rolling_corr``, ``ewmcov``, ``ewmcorr``,
@@ -191,7 +191,7 @@ API changes
191191
<stats.moments.corr_pairwise>` in the docs.
192192

193193
.. ipython:: python
194-
194+
195195
df = DataFrame(np.random.randn(10,4),columns=list('ABCD'))
196196
covs = rolling_cov(df[['A','B','C']], df[['B','C','D']], 5, pairwise=True)
197197
covs[df.index[-1]]
@@ -347,11 +347,10 @@ Enhancements
347347
~~~~~~~~~~~~
348348

349349
- ``DataFrame.to_latex`` now takes a longtable keyword, which if True will return a table in a longtable environment. (:issue:`6617`)
350-
- pd.read_clipboard will, if 'sep' is unspecified, try to detect data copied from a spreadsheet
350+
- ``pd.read_clipboard`` will, if 'sep' is unspecified, try to detect data copied from a spreadsheet
351351
and parse accordingly. (:issue:`6223`)
352352
- ``plot(legend='reverse')`` will now reverse the order of legend labels for
353353
most plot kinds. (:issue:`6014`)
354-
- improve performance of slice indexing on Series with string keys (:issue:`6341`, :issue:`6372`)
355354
- Hexagonal bin plots from ``DataFrame.plot`` with ``kind='hexbin'`` (:issue:`5478`)
356355
- Joining a singly-indexed DataFrame with a multi-indexed DataFrame (:issue:`3662`)
357356

@@ -388,13 +387,14 @@ Enhancements
388387
and data_label which allow the time stamp and dataset label to be set when creating a
389388
file. (:issue:`6545`)
390389
- ``pandas.io.gbq`` now handles reading unicode strings properly. (:issue:`5940`)
391-
- Improve performance of ``CustomBusinessDay`` (:issue:`6584`)
392390

393391
Performance
394392
~~~~~~~~~~~
395393

396394
- perf improvements in DataFrame construction with certain offsets, by removing faulty caching
397395
(e.g. MonthEnd,BusinessMonthEnd), (:issue:`6479`)
396+
- Improve performance of ``CustomBusinessDay`` (:issue:`6584`)
397+
- improve performance of slice indexing on Series with string keys (:issue:`6341`, :issue:`6372`)
398398

399399
Experimental
400400
~~~~~~~~~~~~

0 commit comments

Comments
 (0)