Skip to content

DOC: Add clear and other parameter docs to assert_produces_warning #19066

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
Jan 10, 2018

Conversation

dave-lewis-alida
Copy link
Contributor

@jreback jreback added the Docs label Jan 4, 2018

Parameters
----------
expected_warning : class Warning|False|None, default Warning
Copy link
Contributor

Choose a reason for hiding this comment

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

{Warning, False, None}

suppressed by this context manager. If ``None`` is specified,
the ``__warningsregistry__`` keeps track of which warnings have been
shown, and does not show them again.
check_stacklevel : bool, default true
Copy link
Contributor

Choose a reason for hiding this comment

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

true -> True

line that implements the function is displayed.

Examples
----------
Copy link
Contributor

Choose a reason for hiding this comment

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

make this same length as Examples

Specifies whether warnings are ignored, displayed, or turned
into errors.
Valid values are:
"error" - turns matching warnings into exeptions
Copy link
Contributor

Choose a reason for hiding this comment

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

can you use * for the bullets.

@jreback jreback added the Testing pandas testing functions or related to the test suite label Jan 4, 2018
@codecov
Copy link

codecov bot commented Jan 4, 2018

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #19066   +/-   ##
=======================================
  Coverage   91.51%   91.51%           
=======================================
  Files         148      148           
  Lines       48780    48780           
=======================================
  Hits        44639    44639           
  Misses       4141     4141
Flag Coverage Δ
#multiple 89.88% <0%> (ø) ⬆️
#single 41.61% <0%> (+0.01%) ⬆️

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 78147e9...f46920c. Read the comment docs.

@dave-lewis-alida
Copy link
Contributor Author

Thanks for the quick and thorough review @jreback. I've pushed your requested changes.

@jreback
Copy link
Contributor

jreback commented Jan 4, 2018

can you git merge master and push again (generally we want to rebase / merge master anytime you push).

@dave-lewis-alida
Copy link
Contributor Author

I did git merge master and then git push origin doc_clear on my feature branch in my forked repo. Is that correct? The git messages were "Already up-to-date" and "Everything up-to-date".

@jreback
Copy link
Contributor

jreback commented Jan 4, 2018

git merge upstream sorry you need to pull from the upstream (this should point to the pandas-dev/master.git``

(pandas) bash-3.2$ git remote -v
jreback https://github.com/jreback/pandas.git (fetch)
jreback https://github.com/jreback/pandas.git (push)
upstream        https://github.com/pandas-dev/pandas.git (fetch)
upstream        https://github.com/pandas-dev/pandas.git (push)

@TomAugspurger
Copy link
Contributor

Whoops, looks like some unrelated commits got in here. Do you want help walking through the git commands?

I think the simplest version would be

git reset --soft upstream/master
git commit -m "Fixed git issue"
git push -f origin

That'll rewrite history (which is usually not good, but OK for this PR) and hopefully clean everything up.

@dave-lewis-alida
Copy link
Contributor Author

@TomAugspurger Hi Tom. I ran the commands above. Are there any additional commands I need to run to deliver this change? Thanks!

@TomAugspurger
Copy link
Contributor

The diff looks good now, thanks. Let us know if you see that the tests all pass before we do.

@dave-lewis-alida
Copy link
Contributor Author

I need help with troubleshooting the travis-ci errors. I don't understand what the problem is. Thanks!

@TomAugspurger
Copy link
Contributor

I restarted those. I think boto (one of our dependencies) had a bad release yesterday. They've been passing today.

Ping on green :)

@jreback jreback added this to the 0.23.0 milestone Jan 10, 2018
@jreback jreback merged commit 64c1920 into pandas-dev:master Jan 10, 2018
@jreback
Copy link
Contributor

jreback commented Jan 10, 2018

thanks!

@dave-lewis-alida dave-lewis-alida deleted the doc_clear branch January 10, 2018 16:29
maximveksler pushed a commit to maximveksler/pandas that referenced this pull request Jan 11, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Testing pandas testing functions or related to the test suite
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: tm.assert_produces_warning kwarg clear is undocumented
3 participants