Skip to content

Fix ReST formatting of pandas.read_excel usecols #25801

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 1 commit into from
Mar 20, 2019

Conversation

timhoffm
Copy link
Contributor

Fix some reStructuredText issues in usecols parameter of read_excel

  • bulletlists must start with a space
  • the deprecated/versionadded directives do only apply to the respective bullet point an thus need to be indented.

Comapre http://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.read_excel.html for the current formatting issues.

@WillAyd
Copy link
Member

WillAyd commented Mar 20, 2019

Thanks for the PR. Was this causing an issue in rendering? Quick glance at production docs look OK

@WillAyd WillAyd added the Docs label Mar 20, 2019
@codecov
Copy link

codecov bot commented Mar 20, 2019

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #25801   +/-   ##
=======================================
  Coverage   91.27%   91.27%           
=======================================
  Files         173      173           
  Lines       53002    53002           
=======================================
  Hits        48375    48375           
  Misses       4627     4627
Flag Coverage Δ
#multiple 89.83% <ø> (ø) ⬆️
#single 41.77% <ø> (ø) ⬆️
Impacted Files Coverage Δ
pandas/io/excel/_base.py 92.48% <ø> (ø) ⬆️

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 85c3f82...ee7e6ee. Read the comment docs.

1 similar comment
@codecov
Copy link

codecov bot commented Mar 20, 2019

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #25801   +/-   ##
=======================================
  Coverage   91.27%   91.27%           
=======================================
  Files         173      173           
  Lines       53002    53002           
=======================================
  Hits        48375    48375           
  Misses       4627     4627
Flag Coverage Δ
#multiple 89.83% <ø> (ø) ⬆️
#single 41.77% <ø> (ø) ⬆️
Impacted Files Coverage Δ
pandas/io/excel/_base.py 92.48% <ø> (ø) ⬆️

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 85c3f82...ee7e6ee. Read the comment docs.

@timhoffm
Copy link
Contributor Author

@WillAyd:

  1. Two bullet points are lost in the text follow.
  2. The deprecated/versionadded notes should be indented to align with the text of their respective bullet point.

grafik

@WillAyd WillAyd added this to the 0.25.0 milestone Mar 20, 2019
@WillAyd WillAyd merged commit fbe2523 into pandas-dev:master Mar 20, 2019
@WillAyd
Copy link
Member

WillAyd commented Mar 20, 2019

Makes sense - thanks @timhoffm

@timhoffm timhoffm deleted the fix-doc-read_excel branch March 21, 2019 06:20
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