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

[Docs update] Duplicated "probabilistic frequency" in the schema browser #182

Closed matamadio closed 1 year ago

matamadio commented 1 year ago

There seems to be a duplication of terms: https://rdl-standard.readthedocs.io/en/dev/reference/browser/

Also note in the description: event_set.analysis_type = event_set.analysis_type = 'probabilistic'

matamadio commented 1 year ago

This seem to occur in other sections of the schema brower, so it was just me not getting it.

I'm not seeing the value of the yellow buttons and boxes - they all give duplicated information, which add a lot of stuff on screen and it is somehow confusing where they appear.

I'm suggesting to remove them.

duncandewhurst commented 1 year ago

+1

To do this, we'll need remove the type key from properties with a $ref, e.g.

{
  "probabilistic": {
    "title": "Probabilistic frequency",
    "type": "object",
    "description": "How often the event is expected to occur. Can be return period and/or probability. Both fields are provided to allow entry of return period (most common term used across all hazards) and/or probability, which is commonly used for seismic hazard. Probability commonly refers to a probability within 1 year or 50 years, but may be relative to any duration - when `probability` is used, `span` must be specified. You should only use this object when `event_set.analysis_type` = `event_set.analysis_type` = 'probabilistic'",
    "$ref": "#/$defs/Probabilistic",
    "minProperties": 1
  }
}

Should be

{
  "probabilistic": {
    "title": "Probabilistic frequency",
    "description": "How often the event is expected to occur. Can be return period and/or probability. Both fields are provided to allow entry of return period (most common term used across all hazards) and/or probability, which is commonly used for seismic hazard. Probability commonly refers to a probability within 1 year or 50 years, but may be relative to any duration - when `probability` is used, `span` must be specified. You should only use this object when `event_set.analysis_type` = `event_set.analysis_type` = 'probabilistic'",
    "$ref": "#/$defs/Probabilistic",
    "minProperties": 1
  }
}