Skip to content

DOC: Fix outdated default values in util.testing docstrings #22776

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 3 commits into from
Sep 20, 2018
Merged

DOC: Fix outdated default values in util.testing docstrings #22776

merged 3 commits into from
Sep 20, 2018

Conversation

dargueta
Copy link
Contributor

  • closes #xxxx
  • tests added / passed
  • passes git diff upstream/master -u -- "*.py" | flake8 --diff
  • whatsnew entry

@pep8speaks
Copy link

Hello @dargueta! Thanks for submitting the PR.

file_to_check.py:2407:-258: W605 invalid escape sequence '('
file_to_check.py:2407:-255: W605 invalid escape sequence ')'


@@ -1326,12 +1326,13 @@ def assert_frame_equal(left, right, check_dtype=True,
Second DataFrame to compare.
check_dtype : bool, default True
Whether to check the DataFrame dtype is identical.
check_index_type : {'equiv'} or bool, default 'equiv'
check_index_type : bool / string {'equiv'}, default 'equiv'
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think this and everything below it in this diff is from a botched rebase. Trying to fix it...

@codecov
Copy link

codecov bot commented Sep 20, 2018

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #22776   +/-   ##
=======================================
  Coverage   92.17%   92.17%           
=======================================
  Files         169      169           
  Lines       50778    50778           
=======================================
  Hits        46807    46807           
  Misses       3971     3971
Flag Coverage Δ
#multiple 90.59% <ø> (ø) ⬆️
#single 42.33% <ø> (ø) ⬆️
Impacted Files Coverage Δ
pandas/util/testing.py 86.03% <ø> (ø) ⬆️

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 1c113db...4fed465. Read the comment docs.

@jorisvandenbossche jorisvandenbossche changed the title Fix outdated docstrings with wrong default values DOC: Fix outdated default values in util.testing docstrings Sep 20, 2018
@jorisvandenbossche jorisvandenbossche added this to the 0.24.0 milestone Sep 20, 2018
@jorisvandenbossche jorisvandenbossche merged commit 793b24e into pandas-dev:master Sep 20, 2018
@jorisvandenbossche
Copy link
Member

@dargueta Thanks !

@dargueta dargueta deleted the assert_frame_equal_docfix branch September 20, 2018 17:19
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.

3 participants