petern48 opened a new issue, #2617:
URL: https://github.com/apache/sedona/issues/2617

   While looking at https://github.com/apache/sedona/pull/2616, I noticed many 
function headers in the [Raster Operations 
docs](https://github.com/apache/sedona/blob/aeb88221871a1b2f5f4604bbb36a683093c38e15/docs/api/sql/Raster-operators.md?plain=1#L1030)
 are listed in order from most to least function arguments. In general, I think 
it's better to order it from least to most because that reading order is more 
intuitive to see what parameters are optional and often puts the most commonly 
used function header first.
   
   Here's an example of the current order of RS_Count, for example.
   ```
   RS_Count(raster: Raster, band: Integer = 1, excludeNoDataValue: Boolean = 
true)
   
   RS_Count(raster: Raster, band: Integer = 1)
   
   RS_Count(raster: Raster)
   ```
   
   I think it's better to instead list it like this:
   
   ```
   RS_Count(raster: Raster)
   
   RS_Count(raster: Raster, band: Integer = 1)
   
   RS_Count(raster: Raster, band: Integer = 1, excludeNoDataValue: Boolean = 
true)
   ```
   
   List of functions that I noticed had this problem (there could be more):
   - RS_AddBand
   - RS_Count
   - RS_Resample
   - RS_SetBandNoDataValue
   - RS_ZonalStats
   - RS_ZonalStatsAll
   - etc. (there are certainly more)
   
   Interestingly, some functions like `RS_NormalizeAll ` and `RS_Interpolate` 
are already in the desired order.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to