#3717 closed defect (fixed)
geocode_intersection documentation has wrong parameter name for maximum results returned
| Reported by: | znmeb | Owned by: | robe |
|---|---|---|---|
| Priority: | medium | Milestone: | PostGIS 2.3.3 |
| Component: | documentation | Version: | 2.3.x |
| Keywords: | geocoder, intersection | Cc: |
Description
The documentation for geocode_intersection specifies the maximum number of results returned by the name "max_results". (http://postgis.net/docs/Geocode_Intersection.html). However, the parameter name in the function definition is "num_results". See attached screenshot from PgAdmin4.
Attachments (1)
Change History (3)
by , 7 years ago
| Attachment: | Screenshot from 2017-02-20 19-40-00.png added |
|---|
comment:2 by , 7 years ago
I actually like the term max_results better since it may return fewer than that.
That said the docs should agree. I might change the name in PostGIS 2.4 though to num_results (and mark as possible breaking change).
I have other changes in works on PostGIS 2.4 that are half done, so not going to commit to 2.4 yet.
Note:
See TracTickets
for help on using tickets.
Screenshot showing argument names for geocode_intersection