Update usage and schema documentation #70
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I published the docs (triggered docs CI manually) from this branch so we can view the rendered docs. We can delete the 0.5.1 version from the docs when we publish the 0.6 release version |
TomAugspurger
approved these changes
Jun 25, 2024
|
|
||
| Except for the [legacy API](api/legacy.md), [Apache Arrow](https://arrow.apache.org/) is used as the in-memory interchange format between all formats. While some end-to-end helper functions are provided, the user can go through Arrow objects for maximal flexibility in the conversion process. | ||
|
|
||
| All functionality that goes through Arrow is currently exported via the `stac_geoparquet.arrow` namespace. |
There was a problem hiding this comment.
I think that an example here (or on the index page?) from STAC -> geoparquet would be valuable.
We have the one currently at https://github.com/stac-utils/stac-geoparquet?tab=readme-ov-file#usage. Even an example using a simple pystac.Item() built locally would be good to have.
There was a problem hiding this comment.
I added a simple example below
gadomski
reviewed
Jun 25, 2024
Co-authored-by: Tom Augspurger <[email protected]>
Co-authored-by: Pete Gadomski <[email protected]>
Co-authored-by: Pete Gadomski <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change list
pystac.Iteminput whereverdictis allowed