Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review function names and behavior in this package #313

Open
yeesian opened this issue Jul 11, 2022 · 0 comments
Open

Review function names and behavior in this package #313

yeesian opened this issue Jul 11, 2022 · 0 comments
Milestone

Comments

@yeesian
Copy link
Owner

yeesian commented Jul 11, 2022

(The last time I went through such an exercise was in yeesian/GDALUtils.jl#2 (comment).)

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 write geopackage #263 (comment))
  2. it should be sufficiently inferable from the corresponding GDAL C function names for discoverability (c.f.rename layerdefn to getlayerdefn or provide alias #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
@yeesian yeesian added this to the v1.0 milestone Jul 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant