docs: Document the SedonaDB CRS/Geography/Type model
- Dominant language
- Rust
- Stars
- 503
- Forks
- 61
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 90
Description
After https://github.com/apache/sedona-db/pull/962 we have fresh eyes on the CRS/ItemCRS/Raster CRS stack thanks to @james-willis, who noted that we should document some of the things that came up as issues.
Related is the Geography / Edges model, which iteracts with the CRS model through the geographic params (and via errors trying to set a Geographical CRS to a non-geographic system). I am not sure if these should be documented on the same page but they should at least be documented (we might want a "data type" level of reference document, too...our "data type"s are more like the ArgMatcher variants and this is a little unique).
Contributor guide
Research direction
Start by reviewing PR #962 and the CRS/ItemCRS/Raster CRS model it discusses. Trace how Geography and Edges interact with geographic parameters, including errors when assigning a geographical CRS to a non-geographic system. Done means the CRS and Geography/Edges models and their interactions are documented in an appropriate reference location.
Written by the indexing model from the issue text.
Assessment
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100