DOC: Clean-up references to v12 to v14 (both included) #17420

topper-123 · 2017-09-02T13:33:38Z

closes #xxxx
tests added / passed
[x ] passes git diff upstream/master -u -- "*.py" | flake8 --diff
whatsnew entry

This is a continution of #17375 and cleans up references to old versions of pandas in the documentation.

Somme issues, I'd appreciate input on:

In enhancingperf.rst there is under "Expression Evaluation via :func:~pandas.eval (Experimental)" and "The DataFrame.eval method (Experimental)" a line ..versionadded:: 0.13.
In general I think it's a bit weird that something introduced back in 0.13 still is marked as experimental. I've let the versionadded stay for now, to somehow mark that eval is quite old even though it is experimental. Are there thoughts whether eval should still be marked experimental?

codecov · 2017-09-02T14:06:32Z

Codecov Report

Merging #17420 into master will decrease coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master   #17420      +/-   ##
==========================================
- Coverage   91.15%   91.14%   -0.02%     
==========================================
  Files         163      163              
  Lines       49581    49581              
==========================================
- Hits        45198    45190       -8     
- Misses       4383     4391       +8

Flag	Coverage Δ
#multiple	`88.92% <ø> (ø)`	⬆️
#single	`40.25% <ø> (-0.07%)`	⬇️

Impacted Files	Coverage Δ
pandas/io/gbq.py	`25% <0%> (-58.34%)`	⬇️
pandas/core/frame.py	`97.72% <0%> (-0.1%)`	⬇️
pandas/core/indexes/datetimes.py	`95.43% <0%> (+0.09%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1981b67...aee6a29. Read the comment docs.

codecov · 2017-09-02T14:06:50Z

Codecov Report

Merging #17420 into master will decrease coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master   #17420      +/-   ##
==========================================
- Coverage   91.15%   91.14%   -0.02%     
==========================================
  Files         163      163              
  Lines       49581    49581              
==========================================
- Hits        45198    45189       -9     
- Misses       4383     4392       +9

Flag	Coverage Δ
#multiple	`88.92% <ø> (ø)`	⬆️
#single	`40.25% <ø> (-0.07%)`	⬇️

Impacted Files	Coverage Δ
pandas/io/gbq.py	`25% <0%> (-58.34%)`	⬇️
pandas/core/frame.py	`97.72% <0%> (-0.1%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1981b67...b3d1ea1. Read the comment docs.

jreback

couple of comments; also maybe in a separate PR we have lots of versionsdded refs in doc strings

jreback · 2017-09-02T14:26:54Z

doc/source/indexing.rst

@@ -1790,7 +1773,7 @@ Evaluation order matters

 Furthermore, in chained expressions, the order may determine whether a copy is returned or not.
 If an expression will set values on a copy of a slice, then a ``SettingWithCopy``
-exception will be raised (this raise/warn behavior is new starting in 0.13.0)
+exception will be raised.


this is only a warning by default (and depends on the value of the option for raise/warn)

jreback · 2017-09-02T14:28:28Z

doc/source/io.rst

@@ -3078,8 +3062,7 @@ any pickled pandas object (or any other pickled object) from file:

 .. warning::

-   Several internal refactorings, 0.13 (:ref:`Series Refactoring <whatsnew_0130.refactoring>`), and 0.15 (:ref:`Index Refactoring <whatsnew_0150.refactoring>`),
-   preserve compatibility with pickles created prior to these versions. However, these must


I would actually leave something this warning because this also applies for 0.19 to current

I've looked through the what's new section and can find some changes in pickling but can't find anything new about incompatibility. Could you guide me to the relevant section?

@jreback , I've made a proposal on this warning text, that is more general in nature.

If you pictured something different, let me know.

http://pandas.pydata.org/pandas-docs/stable/whatsnew.html#reorganization-of-the-library-privacy-changes

generally for pickle you should simply use pd.read_pickle as we can preserve back compat

Ok, I've written it anew

also update link to python.org

jreback · 2017-09-04T23:46:24Z

In enhancingperf.rst there is under "Expression Evaluation via :func:~pandas.eval (Experimental)" and "The DataFrame.eval method (Experimental)" a line ..versionadded:: 0.13.
In general I think it's a bit weird that something introduced back in 0.13 still is marked as experimental. I've let the versionadded stay for now, to somehow mark that eval is quite old even though it is experimental. Are there thoughts whether eval should still be marked experimental?

yeah you can take the Experimental off.

jreback · 2017-09-04T23:47:33Z

doc/source/enhancingperf.rst

   to a cython function. Instead pass the actual ``ndarray`` using the ``.values`` attribute of the Series.

-   Prior to 0.13.0
+   So, do not do this:


maybe:

This will fail because the cython definition is specific to an ndarray and not the passed Series

jreback · 2017-09-04T23:48:32Z

doc/source/io.rst

+   See `here <http://pandas.pydata.org/pandas-docs/stable/whatsnew.html#whatsnew-0130-refactoring>`__
+   and `here <http://pandas.pydata.org/pandas-docs/stable/whatsnew.html#whatsnew-0150-refactoring>`__
+   for some examples of compatibility-breaking changes. See
+   `this question <http://stackoverflow.com/questions/20444593/pandas-compiled-from-source-default-pickle-behavior-changed>`__


this is good.

jreback · 2017-09-04T23:48:50Z

doc/source/io.rst

-.. versionadded:: 0.13.0
-
-Starting in 0.13.0, pandas is supporting the ``msgpack`` format for
+pandas supports the ``msgpack`` format for


is this just underlyined in the diff?

There no underline here: https://github.com/topper-123/pandas/blob/15e94c4aad7065db86e713e219aed94b6a80d800/doc/source/io.rst. a bit weird, but my guess is that it's ok

Can't see anything stand out locally either.

jreback

just a couple of minor comments. ping when ready and green.

topper-123 · 2017-09-05T01:41:47Z

ping @jreback

jreback · 2017-09-05T10:30:36Z

thanks!

)

tp added 2 commits September 2, 2017 13:55

Cleaned references to versions <0.12 in docs

e0507e8

cleanup references to v12-14, both included

aee6a29

jreback approved these changes Sep 2, 2017

View reviewed changes

gfyoung added the Docs label Sep 2, 2017

Added changes according to comments

8011a02

also update link to python.org

topper-123 force-pushed the cleanup_references_to_v12-v14 branch from 79b9f6d to 8011a02 Compare September 2, 2017 19:18

new version of the pickle warning

15e94c4

jreback reviewed Sep 4, 2017

View reviewed changes

jreback approved these changes Sep 4, 2017

View reviewed changes

Removed experimental status from pd.eval and pd.DataFrame.eval

b3d1ea1

jreback added this to the 0.21.0 milestone Sep 5, 2017

jreback merged commit 5bca6ce into pandas-dev:master Sep 5, 2017

topper-123 mentioned this pull request Sep 5, 2017

DOC: cleaned references to pandas v0.15 and v0.16 in docs #17442

Merged

jbrockmendel pushed a commit to jbrockmendel/pandas that referenced this pull request Sep 10, 2017

DOC: Clean-up references to v12 to v14 (both included) (pandas-dev#17420

42e5e4d

)

topper-123 deleted the cleanup_references_to_v12-v14 branch September 11, 2017 21:10

jowens pushed a commit to jowens/pandas that referenced this pull request Sep 20, 2017

DOC: Clean-up references to v12 to v14 (both included) (pandas-dev#17420

519c57f

)

alanbato pushed a commit to alanbato/pandas that referenced this pull request Nov 10, 2017

DOC: Clean-up references to v12 to v14 (both included) (pandas-dev#17420

91c2531

)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: Clean-up references to v12 to v14 (both included) #17420

DOC: Clean-up references to v12 to v14 (both included) #17420

topper-123 commented Sep 2, 2017

codecov bot commented Sep 2, 2017 •

edited

Loading

codecov bot commented Sep 2, 2017 •

edited

Loading

jreback left a comment

jreback Sep 2, 2017

jreback Sep 2, 2017

topper-123 Sep 2, 2017

topper-123 Sep 2, 2017 •

edited

Loading

jreback Sep 3, 2017

topper-123 Sep 3, 2017

jreback commented Sep 4, 2017

jreback Sep 4, 2017

jreback Sep 4, 2017

jreback Sep 4, 2017

topper-123 Sep 5, 2017

jreback left a comment

topper-123 commented Sep 5, 2017

jreback commented Sep 5, 2017

DOC: Clean-up references to v12 to v14 (both included) #17420

DOC: Clean-up references to v12 to v14 (both included) #17420

Conversation

topper-123 commented Sep 2, 2017

codecov bot commented Sep 2, 2017 • edited Loading

Codecov Report

codecov bot commented Sep 2, 2017 • edited Loading

Codecov Report

jreback left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

topper-123 Sep 2, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jreback commented Sep 4, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jreback left a comment

Choose a reason for hiding this comment

topper-123 commented Sep 5, 2017

jreback commented Sep 5, 2017

codecov bot commented Sep 2, 2017 •

edited

Loading

codecov bot commented Sep 2, 2017 •

edited

Loading

topper-123 Sep 2, 2017 •

edited

Loading