[MDEV-7511] Lack of documentation for GIS in MariaDB KB Created: 2015-01-27 Updated: 2015-02-19 Resolved: 2015-02-19 |
|
| Status: | Closed |
| Project: | MariaDB Server |
| Component/s: | Documentation |
| Affects Version/s: | N/A |
| Fix Version/s: | N/A |
| Type: | Bug | Priority: | Major |
| Reporter: | Elena Stepanova | Assignee: | Ian Gilfillan |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | documentation, gis | ||
| Description |
|
In 10.1.3 we are going to have new GIS features that need to be documented (see the separate email from Holyfoot); but I also found that our existing documentation for GIS is scarce and apparently incomplete. I started with the simple function ST_AsText(...), which is apparently a synonym for AsText(...), but couldn't find any mention of it. I suppose there are many more missing. I also had a brief chat with a user who, after taking a quick look at our KB, said that "maria gis implementation is still a bit poor" – which might be true to some extent, but I suppose the lack of documentation is also a part of the problem which creates this impression. The area needs to be revised and consistently documented. |
| Comments |
| Comment by Ian Gilfillan [ 2015-02-02 ] |
|
The topic as a whole can be improved in many ways, but are you aware of any specific gaps besides the synonyms (there seem to be a number of these with ST_ synonyms) and the new 10.1.3 changes? |
| Comment by Elena Stepanova [ 2015-02-02 ] |
|
I don't have any specifics now because I didn't verify documentation further while running the tests; I will try to add notes about gaps if I encounter any. |
| Comment by Ian Gilfillan [ 2015-02-19 ] |
|
Closing, as the ST_* synonyms are now documented, and functions now also have examples. There are obviously further improvements that will be made, but specific issues that are still missing can be raised as separate tasks. |