Opened 6 years ago
Closed 4 years ago
#4371 closed defect (wontfix)
Use consistent verb form in one-line function descriptions
Reported by: | dbaston | Owned by: | dbaston |
---|---|---|---|
Priority: | low | Milestone: | PostGIS 3.1.0 |
Component: | postgis | Version: | master |
Keywords: | Cc: |
Description
The one-line function descriptions that appear in the help docs are a mixture of imperatives
ST_NPoints — Return the number of points (vertexes) in a geometry.
Or descriptions
ST_NDims — Returns coordinate dimension of the geometry as a small int. Values are: 2,3 or 4.
These should be made consistent (always "return" or always "returns")
Change History (6)
comment:1 by , 5 years ago
Milestone: | PostGIS 2.5.3 → PostGIS 3.0.0 |
---|
comment:2 by , 5 years ago
comment:4 by , 5 years ago
Milestone: | PostGIS 3.0.0 → PostGIS 3.1.0 |
---|---|
Version: | 2.4.x → trunk |
comment:5 by , 5 years ago
Owner: | changed from | to
---|
comment:6 by , 4 years ago
Resolution: | → wontfix |
---|---|
Status: | new → closed |
Note:
See TracTickets
for help on using tickets.
Dan, any preference for which verb form to use?
I did a very brief scan of other docs, but the results are inconclusive. The OGC SFS 99-049 uses "Returns", while the Postgres documentation seems to mostly use "Return" (e.g. see the string functions doc).
My leaning is towards "Returns" etc.