Skip to content

DOC: Various doc fixes #16035

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 6 commits into from
Apr 18, 2017
Merged

Conversation

TomAugspurger
Copy link
Contributor

  • Fixed spacing
  • Fixed method reference
  • Fixed list line wrapping
  • Fixed unbalanced ticks
  • Fixed section-heading without colon
  • Changed Interval Properties -> Attributes
  • Changed Styler properties

xref #16033

Will probably do more as followups, so let's keep that open.

@@ -1357,9 +1357,9 @@ If indicated, a deprecation warning will be issued if you reference theses modul
"pandas._testing", "pandas.util.libtesting", ""
"pandas._window", "pandas.core.libwindow", ""

- The function :func:`~pandas.api.type.union_categoricals` is now importable from ``pandas.api.types``, formerly from ``pandas.types.concat`` (:issue:`15998`)
- The function :func:`~pandas.api.type.union_categoricals` is now importable from ``pandas.api.types``, formerly from ```pandas.types.concat`` (:issue:`15998`)
Copy link
Member

Choose a reason for hiding this comment

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

also pandas.api.type.union_categoricals -> pandas.api.types.union_categoricals

will be used to determine the groups (the Series' values are first
aligned; see ``.align()`` method). If an ndarray is passed, the
values as-is determine the groups. A str or list of strs maybe be
used used to group by the columns in ``self``.
Copy link
Member

Choose a reason for hiding this comment

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

used used

index. If a dict or Series is passed, the Series or dict VALUES
will be used to determine the groups (the Series' values are first
aligned; see ``.align()`` method). If an ndarray is passed, the
values as-is determine the groups. A str or list of strs maybe be
Copy link
Member

Choose a reason for hiding this comment

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

maybe -> may be ?

@jorisvandenbossche jorisvandenbossche added this to the 0.20.0 milestone Apr 17, 2017
- Fixed spacing
- Fixed method reference
- Fixed list line wrapping
- Fixed unbalanced ticks
- Fixed section-heading without colon
- Changed Interval Properties -> Attributes
- Changed Styler properties
@jorisvandenbossche
Copy link
Member

@TomAugspurger maybe leave the changes to the html repr for a separate PR?

@TomAugspurger
Copy link
Contributor Author

TomAugspurger commented Apr 18, 2017 via email

@TomAugspurger
Copy link
Contributor Author

Doc build passed. Remaining warnings

WARNING: could not import _license.show_info
�[31mWARNING: while setting up extension conf.py: directive 'autosummary' is already registered, it will be overridden
�[31mWARNING: [autosummary] failed to import 'pandas.DataFrame.columns': no module named pandas.DataFrame.columns
�[39;49;00m�[31mWARNING: [autosummary] failed to import 'pandas.DataFrame.index': no module named pandas.DataFrame.index
�[39;49;00m�[31mWARNING: [autosummary] failed to import 'pandas.Panel.items': no module named pandas.Panel.items
�[39;49;00m�[31mWARNING: [autosummary] failed to import 'pandas.Panel.major_axis': no module named pandas.Panel.major_axis
�[39;49;00m�[31mWARNING: [autosummary] failed to import 'pandas.Panel.minor_axis': no module named pandas.Panel.minor_axis
�[39;49;00m�[31mWARNING: [autosummary] failed to import 'pandas.Series.index': no module named pandas.Series.index
�[31m/tmp/doc/source/generated/pandas.IntervalIndex.rst:57: WARNING: toctree references unknown document 'generated/pandas.IntervalIndex.str'
�[39;49;00m�[31m/home/travis/build/pandas-dev/pandas/pandas/core/groupby.py:docstring of pandas.core.groupby.DataFrameGroupBy.describe:16: WARNING: Block quote ends without a blank line; unexpected unindent.
�[39;49;00m�[31m/home/travis/build/pandas-dev/pandas/pandas/core/groupby.py:docstring of pandas.core.groupby.SeriesGroupBy.nlargest:12: WARNING: Block quote ends without a blank line; unexpected unindent.
�[39;49;00m�[31m/home/travis/build/pandas-dev/pandas/pandas/core/groupby.py:docstring of pandas.core.groupby.SeriesGroupBy.nsmallest:12: WARNING: Block quote ends without a blank line; unexpected unindent.
�[39;49;00m�[31m/home/travis/build/pandas-dev/pandas/pandas/io/parsers.py:docstring of pandas.read_csv:158: WARNING: Inline interpreted text or phrase reference start-string without end-string.
�[39;49;00m�[31m/home/travis/build/pandas-dev/pandas/pandas/io/parsers.py:docstring of pandas.read_fwf:157: WARNING: Inline interpreted text or phrase reference start-string without end-string.
�[39;49;00m�[31m/home/travis/build/pandas-dev/pandas/pandas/io/parsers.py:docstring of pandas.read_table:158: WARNING: Inline interpreted text or phrase reference start-string without end-string.
�[39;49;00m�[31m/tmp/doc/source/overview.rst:120: WARNING: Include file '/tmp/LICENSE' not found or reading it failed
�[39;49;00m�[31minternal padding after source/whatsnew/v0.8.0.txt:15: WARNING: image file not readable: ../_static/whatsnew_secondary_y.png
�[39;49;00m�[31minternal padding after source/whatsnew/v0.8.0.txt:19: WARNING: image file not readable: ../_static/whatsnew_kde.png
�[31mNone:None: WARNING: toctree contains reference to nonexisting document 'generated/pandas.IntervalIndex.str'
�[39;49;00m�[31m/home/travis/build/pandas-dev/pandas/pandas/core/indexes/interval.py:docstring of pandas.IntervalIndex:None: WARNING: toctree contains reference to nonexisting document 'generated/pandas.IntervalIndex.str'
�[39;49;00m�[31mNone:None: WARNING: toctree contains reference to nonexisting document 'generated/pandas.IntervalIndex.str'
�[39;49;00m�[31msource/whatsnew/v0.19.0.txt:482: WARNING: undefined label: io.bigquery_authentication (if the link has no caption the label must precede a section header)
�[39;49;00m�[31msource/whatsnew/v0.17.1.txt:60: WARNING: undefined label: style (if the link has no caption the label must precede a section header)

I might have a fix for the DataFrame.index, DataFrame.columns warnings, but not before the release.

I'm not really sure about the IntervalIndex.str warnings.

@jorisvandenbossche
Copy link
Member

@TomAugspurger OK to merge this one? (minus the remaining change to the html)

@jorisvandenbossche
Copy link
Member

I might have a fix for the DataFrame.index, DataFrame.columns warnings, but not before the release.

Yeah, some of those warnings have been there already a very long time, so those are not very important for the release.

I'm not really sure about the IntervalIndex.str warnings.

This should probably be done similar as DatetimeIndex.str, will fix that

@TomAugspurger
Copy link
Contributor Author

TomAugspurger commented Apr 18, 2017

minus the remaining change to the html

0b67961 removed that, but if you want to double check before merging.

@codecov
Copy link

codecov bot commented Apr 18, 2017

Codecov Report

Merging #16035 into master will decrease coverage by 0.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #16035      +/-   ##
==========================================
- Coverage   90.79%   90.77%   -0.02%     
==========================================
  Files         156      156              
  Lines       50534    50535       +1     
==========================================
- Hits        45882    45873       -9     
- Misses       4652     4662      +10
Flag Coverage Δ
#multiple 88.54% <100%> (-0.02%) ⬇️
#single 40.44% <0%> (-0.01%) ⬇️
Impacted Files Coverage Δ
pandas/core/generic.py 91.29% <ø> (ø) ⬆️
pandas/io/formats/style.py 96.28% <ø> (ø) ⬆️
pandas/core/frame.py 97.65% <100%> (ø) ⬆️
pandas/plotting/_converter.py 63.54% <0%> (-1.82%) ⬇️
pandas/util/testing.py 79.81% <0%> (+0.18%) ⬆️

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 816f945...0b67961. Read the comment docs.

@codecov
Copy link

codecov bot commented Apr 18, 2017

Codecov Report

Merging #16035 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #16035   +/-   ##
=======================================
  Coverage   90.79%   90.79%           
=======================================
  Files         156      156           
  Lines       50534    50534           
=======================================
  Hits        45882    45882           
  Misses       4652     4652
Flag Coverage Δ
#multiple 88.56% <ø> (ø) ⬆️
#single 40.44% <ø> (ø) ⬆️
Impacted Files Coverage Δ
pandas/io/formats/style.py 96.28% <ø> (ø) ⬆️
pandas/core/generic.py 91.29% <ø> (ø) ⬆️

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 816f945...0b67961. Read the comment docs.

@jorisvandenbossche jorisvandenbossche merged commit 2522efa into pandas-dev:master Apr 18, 2017
@jorisvandenbossche
Copy link
Member

thanks!

How did you fix the Styler warnings in the end? As I see you reverted what you changed regarding the properties

@TomAugspurger
Copy link
Contributor Author

TomAugspurger commented Apr 18, 2017

template: -> template : 😄

I have no idea why the first triggered an attempted import.

The properties were nice for the docs, but you couldn't use them as class attributes anymore, which is convenient.

@jorisvandenbossche
Copy link
Member

template: -> template : 😄

rst .. (or numpydoc maybe in this case) :-)

analyticalmonk pushed a commit to analyticalmonk/pandas that referenced this pull request Apr 20, 2017
- Fixed spacing
- Fixed method reference
- Fixed list line wrapping
- Fixed unbalanced ticks
- Fixed section-heading without colon
- Changed Interval Properties -> Attributes
- Changed Styler properties
@TomAugspurger TomAugspurger deleted the doc-cleanup branch May 29, 2017 20:43
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.

2 participants