ConsumerDataStandardsAustralia / standards-staging

Other
1 stars 0 forks source link

Clarify RateString description and examples #410

Open nils-work opened 2 weeks ago

nils-work commented 2 weeks ago

Description A small number of queries regarding the format of the RateString type suggests the description and examples could be improved.

Related Work Items Change the current detail: Type Description Valid Examples
RateString A string representing a percentage (e.g. an interest rate). A rate of 100% would be represented by the value 1.0 and a rate of -100% by -1.0
- At least 1 and up to a total of 16 significant digits before decimal point
- Up to 16 digits following the decimal point
- No formatting, eg thousand separating commas
“0.05”(=5%)
“-0.05”(=-5%)
“12.3456789”(=1234.56789%)
“-99.123456789123”(=9912.3456789123%)
To: Type Description Valid Examples
RateString A string representing a percentage (e.g., an interest rate or ratio). For example, a rate of 100% would be represented by the value "1" and a rate of -100% by "-1"
- At least 1 and up to a total of 16 significant digits before a decimal point
- Up to 16 digits following a decimal point if required
- No formatting, e.g., thousand separating commas.
  • "0" or "0.0"  (0%)
  • "1" or "1.0"  (100%)
  • "-1.234567"  (-123.4567%)
  • "-0.056"  (-5.6%)
  • "0.03456789"  (3.456789%)
  • "0.2"  (20%)
  • "23.456"  (2345.6%)