Skip to content

Commit 1eab1a2

Browse files
DOC: small doc fixes (build warning in sym_diff + formatting in release notes)
1 parent 5c211bf commit 1eab1a2

File tree

3 files changed

+26
-25
lines changed

3 files changed

+26
-25
lines changed

doc/source/release.rst

+11-10
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ API Changes
9191
- ``microsecond,nanosecond,qyear``
9292
- ``min(),max()``
9393
- ``pd.infer_freq()``
94+
9495
- ``pd.infer_freq()`` will now raise a ``TypeError`` if given an invalid ``Series/Index``
9596
type (:issue:`6407`, :issue:`6463`)
9697

@@ -99,12 +100,12 @@ API Changes
99100
(:issue:`5987`). For the :class:`~pandas.DataFrame` methods, two things have
100101
changed
101102

102-
- Column names are now given precedence over locals
103-
- Local variables must be referred to explicitly. This means that even if
104-
you have a local variable that is *not* a column you must still refer to
105-
it with the ``'@'`` prefix.
106-
- You can have an expression like ``df.query('@a < a')`` with no complaints
107-
from ``pandas`` about ambiguity of the name ``a``.
103+
- Column names are now given precedence over locals
104+
- Local variables must be referred to explicitly. This means that even if
105+
you have a local variable that is *not* a column you must still refer to
106+
it with the ``'@'`` prefix.
107+
- You can have an expression like ``df.query('@a < a')`` with no complaints
108+
from ``pandas`` about ambiguity of the name ``a``.
108109

109110
- The top-level :func:`pandas.eval` function does not allow you use the
110111
``'@'`` prefix and provides you with an error message telling you so.
@@ -115,6 +116,7 @@ API Changes
115116
longer change type of the resulting index (:issue:`6440`).
116117
- ``set_index`` no longer converts MultiIndexes to an Index of tuples (:issue:`6459`).
117118
- Slicing with negative start, stop & step values handles corner cases better (:issue:`6531`):
119+
118120
- ``df.iloc[:-len(df)]`` is now empty
119121
- ``df.iloc[len(df)::-1]`` now enumerates all elements in reverse
120122

@@ -136,16 +138,15 @@ API Changes
136138

137139
- Fix a bug where invalid eval/query operations would blow the stack (:issue:`5198`)
138140

139-
- Following keywords are now acceptable for :meth:`DataFrame.plot(kind='bar')` and :meth:`DataFrame.plot(kind='barh')`.
141+
- Following keywords are now acceptable for :meth:`DataFrame.plot` with ``kind='bar'`` and ``kind='barh'``:
140142

141143
- `width`: Specify the bar width. In previous versions, static value 0.5 was passed to matplotlib and it cannot be overwritten. (:issue:`6604`)
142144

143145
- `align`: Specify the bar alignment. Default is `center` (different from matplotlib). In previous versions, pandas passes `align='edge'` to matplotlib and adjust the location to `center` by itself, and it results `align` keyword is not applied as expected. (:issue:`4525`)
144146

145-
- `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`)
147+
- `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`)
146148

147-
- Define and document the order of column vs index names in query/eval
148-
(:issue:`6676`)
149+
- Define and document the order of column vs index names in query/eval (:issue:`6676`)
149150

150151
- ``DataFrame.sort`` now places NaNs at the beginning or end of the sort according to the ``na_position`` parameter. (:issue:`3917`)
151152

doc/source/v0.14.0.txt

+13-13
Original file line numberDiff line numberDiff line change
@@ -22,23 +22,23 @@ API changes
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

25-
.. ipython:: python
25+
.. ipython:: python
2626

27-
dfl = DataFrame(np.random.randn(5,2),columns=list('AB'))
28-
dfl
29-
dfl.iloc[:,2:3]
30-
dfl.iloc[:,1:3]
31-
dfl.iloc[4:6]
27+
dfl = DataFrame(np.random.randn(5,2),columns=list('AB'))
28+
dfl
29+
dfl.iloc[:,2:3]
30+
dfl.iloc[:,1:3]
31+
dfl.iloc[4:6]
3232

33-
These are out-of-bounds selections
33+
These are out-of-bounds selections
3434

35-
.. code-block:: python
35+
.. code-block:: python
3636

37-
dfl.iloc[[4,5,6]]
38-
IndexError: positional indexers are out-of-bounds
37+
dfl.iloc[[4,5,6]]
38+
IndexError: positional indexers are out-of-bounds
3939

40-
dfl.iloc[:,4]
41-
IndexError: single positional indexer is out-of-bounds
40+
dfl.iloc[:,4]
41+
IndexError: single positional indexer is out-of-bounds
4242

4343

4444
- The ``DataFrame.interpolate()`` ``downcast`` keyword default has been changed from ``infer`` to
@@ -181,7 +181,7 @@ These are out-of-bounds selections
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``,

pandas/core/index.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1059,7 +1059,7 @@ def diff(self, other):
10591059

10601060
def sym_diff(self, other, result_name=None):
10611061
"""
1062-
Compute the sorted symmetric_difference of two Index objects.
1062+
Compute the sorted symmetric difference of two Index objects.
10631063
10641064
Parameters
10651065
----------
@@ -1077,7 +1077,7 @@ def sym_diff(self, other, result_name=None):
10771077
``idx2`` but not both. Equivalent to the Index created by
10781078
``(idx1 - idx2) + (idx2 - idx1)`` with duplicates dropped.
10791079
1080-
The sorting of a result containing ``NaN``s is not guaranteed
1080+
The sorting of a result containing ``NaN`` values is not guaranteed
10811081
across Python versions. See GitHub issue #6444.
10821082
10831083
Examples

0 commit comments

Comments
 (0)