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

Suppress warning messages in documentation #1991

Merged
merged 37 commits into from
Mar 25, 2021
Merged

Suppress warning messages in documentation #1991

merged 37 commits into from
Mar 25, 2021

Conversation

bchen1116
Copy link
Contributor

@bchen1116 bchen1116 commented Mar 17, 2021

fix #1887

I decided to add hidden cells that caught the warning messages in each notebook. However, it might confuse users when the first code cell execution starts at [2] instead of [1].

Adding a warning into explain_predictions():
image

Having the warning in explain_predictions(), but also catching warnings in notebooks:
image

@bchen1116 bchen1116 self-assigned this Mar 17, 2021
@codecov
Copy link

codecov bot commented Mar 17, 2021

Codecov Report

Merging #1991 (c887774) into main (d175b3e) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1991   +/-   ##
=======================================
  Coverage   100.0%   100.0%           
=======================================
  Files         278      278           
  Lines       22714    22714           
=======================================
  Hits        22705    22705           
  Misses          9        9           

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 d175b3e...c887774. Read the comment docs.

@bchen1116 bchen1116 marked this pull request as ready for review March 17, 2021 15:26
@dsherry
Copy link
Contributor

dsherry commented Mar 17, 2021

However, it might confuse users when the first code cell execution starts at [2] instead of [1].

Ooh good point. I agree. I didn't think of that when we were considering the options. @bchen1116 is there any way around that?

@bchen1116 bchen1116 marked this pull request as draft March 18, 2021 20:04
@bchen1116
Copy link
Contributor Author

Moving forward with the current hidden cell method, but filed an issue here to track simplifying this

Copy link
Contributor

@chukarsten chukarsten left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@ParthivNaresh ParthivNaresh left a comment

Choose a reason for hiding this comment

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

Looks good man, what was the outcome of the configuration file we were looking at before?

@bchen1116
Copy link
Contributor Author

@ParthivNaresh I couldn't get the config file to work out. I think ReadTheDocs ends up looking at a different file on their side, so I sent them an email to follow up on how we can get our config in/update the path!

@bchen1116 bchen1116 merged commit 79128bc into main Mar 25, 2021
@chukarsten chukarsten mentioned this pull request Apr 6, 2021
@freddyaboulton freddyaboulton deleted the bc_1887_warnings branch May 13, 2022 15:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Handle deprecation warnings properly in the documentation
4 participants