NRLMMD-GEOIPS / geoips

Main Geolocated Information Processing System code base with basic functionality enabled.
https://nrlmmd-geoips.github.io/geoips/
Other
13 stars 10 forks source link

Fix RGB_Default Algorithm Top-Level Docstring and Fix RGB-Default Naming #561

Open evrose54 opened 1 month ago

evrose54 commented 1 month ago

Requested Update

Description

GeoIPS algorithm plugin RGB_Default was added in #530 and seems completely unused. I'm not too sure why this was added, but nonetheless, the top-level docstring for that algorithm is incorrect and needs clarification. We need to update this accordingly.

Also, the product_defaults plugin RGB-Default doesn't adhere to proper naming definition. We should rename this to RGB_Default or rename algorithm RGB_Default to RGB-Default. Personally I think we should use the underscore nomenclature because that is largely used throughout GeoIPS.

Background and Motivation

PR #530 introduced these files and we should address them sooner rather than later, for the aforementioned reasons.

Code to demonstrate issue

Checklist for Completion