Improve documentation for MultiScene.blend #1751
Conversation
In the `MultiScene.blend` docstring, explain what it actually does and what the interface of the blend function should be.
Codecov Report
@@ Coverage Diff @@
## main #1751 +/- ##
==========================================
- Coverage 92.83% 92.83% -0.01%
==========================================
Files 260 260
Lines 38556 38558 +2
==========================================
+ Hits 35793 35794 +1
- Misses 2763 2764 +1
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
Fix typos as detected by @djhoese Co-authored-by: David Hoese <david.hoese@ssec.wisc.edu>
|
Can't we also check the RTD website via CI / build website or so? |
|
Well it looks like it doesn't pass right now, but I think if we wanted to do that (link to it and view it) we'd have to do something with artifacts. I'm not sure how that would work and I haven't tried. Could be fun for a PCW/sprint some time. |
|
We could use this: https://github.com/actions/upload-artifact but then we'd have to download the output. Might just be easier to trust that it is going to render properly locally. Also, I think we can opt-in to having readthedocs work on pull requests. |
|
Why is the build website not passing? It looks like it fails already in building up the conda environment? Is this related to my PR? |
|
No, it was a download/connection issue. Restarted now. |
* Improve documentation for MultiScene.blend In the `MultiScene.blend` docstring, explain what it actually does and what the interface of the blend function should be. * Update satpy/multiscene.py Fix typos as detected by @djhoese Co-authored-by: David Hoese <david.hoese@ssec.wisc.edu> * Fix sphinx links Co-authored-by: David Hoese <david.hoese@ssec.wisc.edu>
In the
MultiScene.blenddocstring, explain what it actually does andwhat the interface of the blend function should be.