[postgis-tickets] [PostGIS] #2633: Documentation: Return value not specified

[PostGIS]

#2633: Documentation: Return value not specified
------------------------------------------------------+---------------------
 Reporter:  pseudonym                                 |       Owner:  strk         
     Type:  enhancement                               |      Status:  new          
 Priority:  medium                                    |   Milestone:  PostGIS 2.1.2
Component:  topology                                  |     Version:  2.1.x        
 Keywords:  ST_ModEdgeSplit, documentation, topology  |  
------------------------------------------------------+---------------------
 In the current documentation for ST_ModEdgeSplit, nowhere does it say what
 the return value means.

 It is the id of the newly created node. I (and everyone I asked) assumed
 that because the function name says "edge", the id of the newly created
 edge would be returned, so this one is particularly confusing.

 This probably isn't the only function whose documentation needs updating.

-- 
Ticket URL: <http://trac.osgeo.org/postgis/ticket/2633>
PostGIS <http://trac.osgeo.org/postgis/>
The PostGIS Trac is used for bug, enhancement & task tracking, a user and developer wiki, and a view into the subversion code repository of PostGIS project.