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

Clarify contracts for writers and readers #134

Open
asinghvi17 opened this issue Jun 16, 2024 · 1 comment
Open

Clarify contracts for writers and readers #134

asinghvi17 opened this issue Jun 16, 2024 · 1 comment

Comments

@asinghvi17
Copy link
Member

asinghvi17 commented Jun 16, 2024

In general, users can expect writers (GeoJSON.write, Shapefile.write, GeoParquet.write, GeoDataFrames.write, etc) to accept either feature collections or table-like objects, as *.write(filename, obj). This is not always clear in the READMEs or package docs/docstrings.

This should be clarified in every README for these packages and in the docs as well, if those exist.

Similarly, readers should return a table-like object, possibly a feature collection. At least it should have some metadata. DataAPI.metadata functions should be included so we can propagate crs and geometry column info through e.g. DataFrame(GeoJSON.read(...)).

This is a good first issue to solve since it's mostly documentation modification!

@rafaqz
Copy link
Member

rafaqz commented Jun 16, 2024

I think making them all as much as possible identical is really important too. Like the same keywords, args etc wherever we can.

Even the docs should be basically the same text for the same functionality.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Todo
Development

No branches or pull requests

2 participants