Skip to content

DOC: Fix various warnings #20509

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

Merged
merged 8 commits into from
Mar 29, 2018
Merged

Conversation

TomAugspurger
Copy link
Contributor

No description provided.

@@ -409,7 +409,7 @@ N Dimensional Panels (Experimental)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Adding experimental support for Panel4D and factory functions to create n-dimensional named panels.
:ref:`Docs <dsintro.panel4d>` for NDim. Here is a taste of what to expect.
`Docs` for NDim. Here is a taste of what to expect.
Copy link
Member

Choose a reason for hiding this comment

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

I would just remove the "Docs for NDim" part

@@ -26,7 +26,7 @@ Highlights include:

.. warning::

In pandas 0.17.0, the sub-package ``pandas.io.data`` will be removed in favor of a separately installable package. See :ref:`here for details <remote_data.pandas_datareader>` (:issue:`8961`)
In pandas 0.17.0, the sub-package ``pandas.io.data`` will be removed in favor of a separately installable package. See `here for details` (:issue:`8961`)
Copy link
Member

Choose a reason for hiding this comment

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

same here, I would just remove the "See here for details"

@jreback jreback added this to the 0.23.0 milestone Mar 28, 2018
@codecov
Copy link

codecov bot commented Mar 28, 2018

Codecov Report

Merging #20509 into master will decrease coverage by <.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #20509      +/-   ##
==========================================
- Coverage   91.84%   91.84%   -0.01%     
==========================================
  Files         152      152              
  Lines       49261    49260       -1     
==========================================
- Hits        45245    45244       -1     
  Misses       4016     4016
Flag Coverage Δ
#multiple 90.23% <100%> (-0.01%) ⬇️
#single 41.9% <100%> (-0.01%) ⬇️
Impacted Files Coverage Δ
pandas/core/generic.py 95.85% <ø> (ø) ⬆️
pandas/plotting/_core.py 82.5% <ø> (ø) ⬆️
pandas/util/_decorators.py 82.25% <100%> (-0.15%) ⬇️
pandas/core/series.py 93.85% <100%> (ø) ⬆️
pandas/core/strings.py 98.32% <0%> (ø) ⬆️

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 9b4d0f1...d6eaf5f. Read the comment docs.

@TomAugspurger
Copy link
Contributor Author

OK, if this all passes I think it's ready. There are still a few warnings left, but those are more involved.

@TomAugspurger
Copy link
Contributor Author

I added a toctree for the docstring guide. Here's the rendered version

screen shot 2018-03-28 at 1 21 42 pm

@TomAugspurger TomAugspurger merged commit 0c4e611 into pandas-dev:master Mar 29, 2018
@TomAugspurger TomAugspurger deleted the doc-warnings branch March 29, 2018 02:31
javadnoorb pushed a commit to javadnoorb/pandas that referenced this pull request Mar 29, 2018
dworvos pushed a commit to dworvos/pandas that referenced this pull request Apr 2, 2018
kornilova203 pushed a commit to kornilova203/pandas that referenced this pull request Apr 23, 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.

3 participants