-
Notifications
You must be signed in to change notification settings - Fork 4.5k
Remove dataframe warnings from py38-docs logs #21861
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
Conversation
|
R: @AnandInguva |
|
|
||
| # Fail if there are errors or warnings in docs | ||
| ! grep -q "ERROR:" target/docs/sphinx-build.warnings.log || exit 1 | ||
| (! grep -v 'apache_beam.dataframe' target/docs/sphinx-build.warnings.log | grep -q "WARNING:") || exit 1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why apache_beam.dataframe was specified specially here? Just curious
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added a comment above to explain it. The issue is that for the DataFrame API we copy docstrings verbatim from the equivalent pandas methods, and these have various issues that raise warnings in sphinx
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep. Thanks
|
LGTM! |
Codecov Report
@@ Coverage Diff @@
## master #21861 +/- ##
==========================================
- Coverage 74.07% 74.05% -0.03%
==========================================
Files 698 698
Lines 92574 92595 +21
==========================================
- Hits 68577 68571 -6
- Misses 22742 22769 +27
Partials 1255 1255
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
Fixes #21845
This pushes the cutout for
apache_beam.dataframewarnings earlier, so that they don't even show up in the log.I confirmed that this will still catch errors by introducing an indentation issue and verifying that the resulting warning caused
tox -e py38-docsto fail.GitHub Actions Tests Status (on master branch)
See CI.md for more information about GitHub Actions CI.