Opened 7 years ago

Last modified 7 weeks ago

#1871 new defect

[raster] ST_Approx raster stats functions are not documented

Reported by: pracine Owned by: robe
Priority: medium Milestone: PostGIS 2.4.6
Component: documentation Version: 2.0.x
Keywords: Cc:

Description


Change History (10)

comment:1 Changed 7 years ago by pracine

And the sample_percent parameter is not listed as possible parameter for the all the stats functions.

comment:2 Changed 6 years ago by robe

Milestone: PostGIS 2.0.2PostGIS 2.0.3

push back if you feel you'll get to it before then.

comment:3 Changed 6 years ago by robe

Milestone: PostGIS 2.0.4PostGIS 2.2.0

comment:4 Changed 4 years ago by robe

Milestone: PostGIS 2.2.0PostGIS 2.1.9

comment:5 Changed 17 months ago by pramsey

Milestone: PostGIS 2.1.9PostGIS 2.2.6

comment:6 Changed 16 months ago by robe

Milestone: PostGIS 2.2.6PostGIS 2.5.0

comment:7 Changed 7 months ago by robe

Milestone: PostGIS 2.5.0PostGIS 2.4.5

comment:8 Changed 5 months ago by pramsey

Milestone: PostGIS 2.4.5PostGIS 2.4.6

comment:9 Changed 7 weeks ago by sunveersingh

Hello there, I would like to work on this, would love if someone can get me started on this.

comment:10 Changed 7 weeks ago by robe

sunveersingh,

Hopefully this will help - if you have any more questions, join our development mailing list.

SHORT ANSWER 1) For new functions (even if they are not knew but just aren't documented) use this template

https://trac.osgeo.org/postgis/browser/trunk/doc/template.xml

2) Attach the updated file to this ticket.

LONG ANSWER

1) Join our developer mailing list especially if you have questions - https://lists.osgeo.org/mailman/listinfo/postgis-devel

2) Don't be shy asking questions on the list. No one should bite you even if you ask a stupid question. We all ask stupid questions. If per chance someone SHOULD bite you, I'll bite them back and you can bite them too :).

3) For documentation - we use docbook, which is an xml format - the raster functions are all documented in doc/reference_raster.xml and general raster usage manual is doc/using_raster_dataman.xml

These you can pull from any of our git and svn mirrors listed way at the bottom of this page - https://postgis.net/source/ (or the latest tar ball https://postgis.net/stuff/postgis-3.0.0dev.tar.gz )

Use the trunk version

4) When you make changes to existing function - you can create a patch to the file and attach it to this ticket. git or svn or regular old patch are all fine.

For new functions such as this one -- just the body of the functions is sufficient - and you follow the format of our template - https://trac.osgeo.org/postgis/browser/trunk/doc/template.xml

You can attach each as separate file to this ticket or just as a single file, repeating the template format of each new function.

Note: See TracTickets for help on using tickets.