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: spellchecked io.rst #19660

Merged
merged 1 commit into from
Feb 14, 2018
Merged

DOC: spellchecked io.rst #19660

merged 1 commit into from
Feb 14, 2018

Conversation

tommyod
Copy link
Contributor

@tommyod tommyod commented Feb 12, 2018

Spellcheck of the docs, specifically of io.rst.
I did not read everything thoroughly, but I believe the suggested changes will help enforce a greater level of consistency in the docs.

  • Backticks `` around Series, DataFrame.
  • Added some function references, i.e. :meth:`~DataFrame.method`.
  • Consistency of booleans, typsetting as False instead of False or False.
  • Minor rephrasing of sentences, spelling, periods, colons etc.

Cheers!

@codecov
Copy link

codecov bot commented Feb 12, 2018

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #19660      +/-   ##
==========================================
+ Coverage   91.58%   91.59%   +<.01%     
==========================================
  Files         150      150              
  Lines       48806    48806              
==========================================
+ Hits        44701    44703       +2     
+ Misses       4105     4103       -2
Flag Coverage Δ
#multiple 89.96% <ø> (ø) ⬆️
#single 41.73% <ø> (ø) ⬆️
Impacted Files Coverage Δ
pandas/util/testing.py 83.85% <0%> (+0.2%) ⬆️

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 569bc7a...9bd5a5b. Read the comment docs.

Copy link
Member

@jorisvandenbossche jorisvandenbossche left a comment

Choose a reason for hiding this comment

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

Thanks a lot for this!

I have my doubts a about the need to quote all occurrences of 'DataFrame', but will open a separate issue for that.

@jorisvandenbossche jorisvandenbossche changed the title Spellchecked io.rst DOC: spellchecked io.rst Feb 12, 2018
@jorisvandenbossche jorisvandenbossche added this to the 0.23.0 milestone Feb 12, 2018
@jreback jreback merged commit d198a6e into pandas-dev:master Feb 14, 2018
@jreback
Copy link
Contributor

jreback commented Feb 14, 2018

thanks @tommyod

I kind of like the formatting when reading with quoted DataFrame/Series.

harisbal pushed a commit to harisbal/pandas that referenced this pull request Feb 28, 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