Fix doc builds for main branch #3792
Conversation
…ameters in DataObject copy_meta_from docstring
github-actions
bot
added
documentation
Codecov Report
@@ Coverage Diff @@
## main #3792 +/- ##
=======================================
Coverage 94.15% 94.15%
=======================================
Files 86 86
Lines 18891 18891
=======================================
Hits 17787 17787
Misses 1104 1104 |
Renderers (and hence wraps in Plotter) class was missing a docstring (copy/paste from Renderer class)
|
From what I can see in doc build logs, 4 warnings seemed to be causing the failure (since we build doc with the I think I was able to remove these warnings by implementing docstrings for aforementioned methods, but I am afraid that we cannot tell the fix is working from this PR's CI, since it appears to behave differently to |
|
Since we try to remove all warnings in doc builds, I am afraid that this warning would need to wait for #3783 to be handled. |
| @@ -139,6 +139,7 @@ filterwarnings = [ | |||
| 'ignore:.*numpy.ufunc size changed.*:RuntimeWarning', | |||
| 'ignore:.*Given trait value dtype "float64":UserWarning', | |||
| 'ignore:.*The NumPy module was reloaded*:UserWarning', | |||
| 'error::pyvista.PyVistaDeprecationWarning' | |||
There was a problem hiding this comment.
I added this warning conversion to an error in oder to detect which docstrings use deprecated methods (when using pytest --doctest-module).
It also serves to asses that warnings are indeed captured in tests.
Let me know if it is fine for you.
This is an attempt to resolve #3782