Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Fix warnings in doc build #22838

Merged
merged 22 commits into from
Sep 26, 2018
Merged

Conversation

TomAugspurger
Copy link
Contributor

Split from #22743

This has just the docs changes, not the doc build / CI changes, so I don't have to keep fixing merge conflicts.

(cherry picked from commit 9f0a948)
Warning about elementwise comparison failing when we indexed
a dataframe with boolean dataframe

(cherry picked from commit 1168273)
(cherry picked from commit 41c8297)
(cherry picked from commit 2e76e84)
(cherry picked from commit a70f86d)
(cherry picked from commit e4a8b06)
(cherry picked from commit 693eead)
(cherry picked from commit e6b2c09)
(cherry picked from commit a7f0b38)
(cherry picked from commit ff3d2dd)
(cherry picked from commit e544249)
(cherry picked from commit 8bdb920)
(cherry picked from commit ae0f8ff)
(cherry picked from commit b190866)
(cherry picked from commit a46e4c7)
(cherry picked from commit 1668c65)
(cherry picked from commit dda2bfc)
@TomAugspurger TomAugspurger added this to the 0.24.0 milestone Sep 26, 2018
@pep8speaks
Copy link

Hello @TomAugspurger! Thanks for submitting the PR.

@TomAugspurger
Copy link
Contributor Author

Latest commit fixes a failing doctest on master

https://travis-ci.org/pandas-dev/pandas/jobs/433544423#L2688

2059             columns of two DataFrame objects.
2060 
2061         Notes
2062         -----
2063         If the Pearson correlation is not well defined return 'NaN'.
2064 
2065         Examples
2066         --------
2067         >>> s = pd.Series([0.25, 0.5, 0.2, -0.05])
2068         >>> s.autocorr()
Expected:
    0.1035526330902407
Got:
    0.10355263309024071

Assuming it's a floating point precision issue. @jorisvandenbossche @datapythonista are you OK with using doctest: +ELLIPSIS for this?

Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great fixes, there are a couple of typos, but looks good.

@@ -186,7 +186,7 @@ Previously, only ``gzip`` compression was supported. By default, compression of
URLs and paths are now inferred using their file extensions. Additionally,
support for bz2 compression in the python 2 C-engine improved (:issue:`14874`).

.. ipython:: python
.. code-block:::: python
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we have an extra pair of colons here?

@@ -2061,9 +2061,10 @@ def to_json(self, path_or_buf=None, orient=None, date_format=None,

.. versionadded:: 0.19.0
compression : {'infer', 'gzip', 'bz2', 'zip', 'xz', None},
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if we remove the default, the tailing comma is not needed

>>> s.autocorr() # doctest: +ELLIPSIS
0.10355...
>>> s.autocorr(lag=2) # doctest: +ELLIPSIS
-0.99999...
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 on doctest: +ELLIPSES

@codecov
Copy link

codecov bot commented Sep 26, 2018

Codecov Report

Merging #22838 into master will increase coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #22838      +/-   ##
==========================================
+ Coverage   92.19%   92.19%   +<.01%     
==========================================
  Files         169      169              
  Lines       50825    50827       +2     
==========================================
+ Hits        46857    46860       +3     
+ Misses       3968     3967       -1
Flag Coverage Δ
#multiple 90.61% <ø> (ø) ⬆️
#single 42.37% <ø> (-0.01%) ⬇️
Impacted Files Coverage Δ
pandas/io/formats/style.py 96.43% <ø> (ø) ⬆️
pandas/core/series.py 93.74% <ø> (ø) ⬆️
pandas/core/generic.py 96.67% <ø> (ø) ⬆️
pandas/core/window.py 96.4% <ø> (ø) ⬆️
pandas/core/indexes/multi.py 95.45% <0%> (ø) ⬆️
pandas/core/frame.py 97.2% <0%> (ø) ⬆️
pandas/core/internals/managers.py 96.66% <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 f64f994...c9b1921. Read the comment docs.

@TomAugspurger
Copy link
Contributor Author

Merging in a bit, since master is failing.

@TomAugspurger
Copy link
Contributor Author

HTTP error downloading conda on that circle-ci one. The others passed, so merging.

@TomAugspurger TomAugspurger merged commit a03d953 into pandas-dev:master Sep 26, 2018
@TomAugspurger TomAugspurger deleted the doc-fixup branch September 26, 2018 19:04
@jorisvandenbossche
Copy link
Member

Thanks a lot for this!

Sup3rGeo pushed a commit to Sup3rGeo/pandas that referenced this pull request Oct 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants