search

yeesian / ArchGDAL.jl

A high level API for GDAL - Geospatial Data Abstraction Library
https://yeesian.github.io/ArchGDAL.jl/stable/
Other
142 stars 26 forks source link

Review function names and behavior in this package #313

Open yeesian opened 2 years ago

yeesian commented 2 years ago

(The last time I went through such an exercise was in https://github.com/yeesian/GDALUtils.jl/issues/2#issue-141488880.)

The considerations I can think of are:

  1. it will not always be 1:1 in behavior with the correspondent GDAL C functions (otherwise there'll be surprises like https://github.com/yeesian/ArchGDAL.jl/issues/263#issue-1045499064)
  2. it should be sufficiently inferable from the corresponding GDAL C function names for discoverability (c.f.https://github.com/yeesian/ArchGDAL.jl/issues/312)
  3. it should be consistent across types (e.g. "create", "write" or "read" etc across different GDAL object types)
  4. they should be documented in https://yeesian.com/ArchGDAL.jl/stable/considerations/#Design-Considerations