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

Documentation correction: Not all built-in compositors derive from GenericCompositor #2274

Merged

Conversation

gerritholl
Copy link
Collaborator

Fix an incorrect statement in the documentation alleging that all compositors are derived from the GenericCompositor. This isn't true. Also add a paragraph on why one might want to use SingleBandCompositor.

  • Fully documented

Fix an incorrect statement in the documentation alleging that all
compositors are derived from the GenericCompositor.  This isn't true.
Also add a paragraph on why one might want to use SingleBandCompositor.
@codecov
Copy link

codecov bot commented Nov 14, 2022

Codecov Report

Merging #2274 (338ec17) into main (3f53644) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #2274   +/-   ##
=======================================
  Coverage   94.30%   94.30%           
=======================================
  Files         306      306           
  Lines       46039    46039           
=======================================
  Hits        43416    43416           
  Misses       2623     2623           
Flag Coverage Δ
behaviourtests 4.62% <ø> (ø)
unittests 94.94% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 94.891% when pulling 338ec17 on gerritholl:fix-composite-doc-untrue-statement into 3f53644 on pytroll:main.

@gerritholl gerritholl changed the title Not all built-in compositors derive from GenericCompositor Documentation correction: Not all built-in compositors derive from GenericCompositor Nov 14, 2022
Copy link
Member

@pnuu pnuu left a comment

Choose a reason for hiding this comment

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

LGTM

@mraspaud mraspaud merged commit 60be391 into pytroll:main Nov 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants