update descriptions for spatial, bbox, coordinates and centroid

GFDRR / rdl-standard

The Risk Data Library Standard (RDLS) is an open data standard to make it easier to work with disaster and climate risk data. It provides a common description of the data used and produced in risk assessments, including hazard, exposure, vulnerability, and modelled loss, or impact, data.

https://docs.riskdatalibrary.org/

Creative Commons Attribution Share Alike 4.0 International

13 stars 1 forks source link

update descriptions for spatial, bbox, coordinates and centroid #207

Closed odscjen closed 11 months ago

odscjen commented 12 months ago

Related issues

closes #197 and closes #201

Description

Merge checklist

[x] Update the changelog (style guide)
[x] Run ./manage.py pre-commit

If you added or removed a field:

[ ] Update the collapse option of the jsonschema directives for dataset, resource, hazard, exposure, vulnerability and loss on reference/schema.md

Having trouble?

See how to resolve check failures.

odscjen commented 12 months ago

@matamadio I've added the specification of the order of the 4 values in bbox and an example to .coordinates. There is no limit to the number of coordinates that can be provided so I've not changed this.

odscjen commented 12 months ago

Also specify that coordinates come in "comma separated values" and not semicolon or other symbols.

The problem with doing this is that this is how it should be put in in JSON but in the spreadsheet template it needs to be semi-colon. The spreadsheet template is generated automatically from the JSON schema pulling the field descriptions into the '# description' row. So if we explicitly say to use CSV values here the relevant columns in the spreadsheet will end up with conflicting guidance.

But we can fit it somewhere into the guidance documentation so I've added a note to the documentation issue.

odscjen commented 12 months ago

We may as well make the schema change proposed in https://github.com/GFDRR/rdl-standard/issues/197#issuecomment-1685436059 since it is an improvement and it is just a case of copy-pasting.

But that thread ends with https://github.com/GFDRR/rdl-standard/issues/197#issuecomment-1690679649 where we agreed the only change that needed made was to update the descriptions?

But I do agree that tightening up the constraints would be a good thing so I'll add that update in anyway

duncandewhurst commented 11 months ago

But that thread ends with #197 (comment) where we agreed the only change that needed made was to update the descriptions?

Yes, sorry. I meant to include implementing the schema change since it is already worked out!