Opened 13 years ago
Closed 9 years ago
#1748 closed defect (fixed)
[raster] st_intersection function names in docs don't match with what's installed
Reported by: | robe | Owned by: | pracine |
---|---|---|---|
Priority: | low | Milestone: | PostGIS 2.2.0 |
Component: | documentation | Version: | master |
Keywords: | Cc: |
Description
I thought we had this right before but I'm noticing the docs have argument names that don't match the argument names installed.
this should match in case people use named arguments. They will expect the documentation names to match what is installed. I propose we leave the function names alone and change the documentation since changing arg names of functions is a somewhat involved process that requires dropping the function.
I thought this used to match did someone try to prettify the docs by changing the names.
e.g
our docs say this:
rast1, band_num1, rast2, band_num2, returnband,nodataval
but our function is coded like this:
rast1, band1 , rast2, band2 , returnband, nodataval
Change History (8)
comment:1 by , 13 years ago
Milestone: | PostGIS 2.0.1 → PostGIS 2.0.2 |
---|
comment:2 by , 12 years ago
Milestone: | PostGIS 2.0.2 → PostGIS 2.0.3 |
---|
comment:3 by , 12 years ago
Milestone: | PostGIS 2.0.3 → PostGIS 2.0.x |
---|
comment:4 by , 11 years ago
Milestone: | PostGIS 2.0.4 → PostGIS 2.1.1 |
---|
comment:5 by , 11 years ago
Milestone: | PostGIS 2.1.1 → PostGIS 2.2.0 |
---|
comment:6 by , 9 years ago
comment:7 by , 9 years ago
Component: | raster → documentation |
---|
Yes it's still an issue and pretty much every raster intersection function that involves bands. The docs called them band_num, band_num1, band_num2 but functions call them band1 and band2.
It's safer to fix the documentation. Changing the functions will require a drop / recreate of them and but we want the doc arg names to agree with the function arg names, otherwise people relying on docs using call by name calling will think our documentation sucks.
There are so many different overloads of ST_Intersection that I don't know which one you are referring to. Could this be re-checked before final ?