From: Aarni Koskela <akx@iki.fi>
Date: Fri, 8 Jan 2016 08:27:58 +0000 (+0200)
Subject: doc: Add CLDR data volatility notes
X-Git-Tag: 2.3.1~30^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F322%2Fhead;p=thirdparty%2Fbabel.git

doc: Add CLDR data volatility notes

Closes #317
---

diff --git a/babel/core.py b/babel/core.py
index c08cfa73..495015d6 100644
--- a/babel/core.py
+++ b/babel/core.py
@@ -529,6 +529,9 @@ class Locale(object):
     def number_symbols(self):
         """Symbols used in number formatting.
 
+        .. note:: The format of the value returned may change between
+                  Babel versions.
+
         >>> Locale('fr', 'FR').number_symbols['decimal']
         u','
         """
@@ -538,6 +541,9 @@ class Locale(object):
     def decimal_formats(self):
         """Locale patterns for decimal number formatting.
 
+        .. note:: The format of the value returned may change between
+                  Babel versions.
+
         >>> Locale('en', 'US').decimal_formats[None]
         <NumberPattern u'#,##0.###'>
         """
@@ -547,6 +553,9 @@ class Locale(object):
     def currency_formats(self):
         """Locale patterns for currency number formatting.
 
+        .. note:: The format of the value returned may change between
+                  Babel versions.
+
         >>> Locale('en', 'US').currency_formats['standard']
         <NumberPattern u'\\xa4#,##0.00'>
         >>> Locale('en', 'US').currency_formats['accounting']
@@ -558,6 +567,9 @@ class Locale(object):
     def percent_formats(self):
         """Locale patterns for percent number formatting.
 
+        .. note:: The format of the value returned may change between
+                  Babel versions.
+
         >>> Locale('en', 'US').percent_formats[None]
         <NumberPattern u'#,##0%'>
         """
@@ -567,6 +579,9 @@ class Locale(object):
     def scientific_formats(self):
         """Locale patterns for scientific number formatting.
 
+        .. note:: The format of the value returned may change between
+                  Babel versions.
+
         >>> Locale('en', 'US').scientific_formats[None]
         <NumberPattern u'#E0'>
         """
@@ -614,6 +629,9 @@ class Locale(object):
     def eras(self):
         """Locale display names for eras.
 
+        .. note:: The format of the value returned may change between
+                  Babel versions.
+
         >>> Locale('en', 'US').eras['wide'][1]
         u'Anno Domini'
         >>> Locale('en', 'US').eras['abbreviated'][0]
@@ -625,6 +643,9 @@ class Locale(object):
     def time_zones(self):
         """Locale display names for time zones.
 
+        .. note:: The format of the value returned may change between
+                  Babel versions.
+
         >>> Locale('en', 'US').time_zones['Europe/London']['long']['daylight']
         u'British Summer Time'
         >>> Locale('en', 'US').time_zones['America/St_Johns']['city']
@@ -639,6 +660,9 @@ class Locale(object):
         Meta time zones are basically groups of different Olson time zones that
         have the same GMT offset and daylight savings time.
 
+        .. note:: The format of the value returned may change between
+                  Babel versions.
+
         >>> Locale('en', 'US').meta_zones['Europe_Central']['long']['daylight']
         u'Central European Summer Time'
 
@@ -650,6 +674,9 @@ class Locale(object):
     def zone_formats(self):
         """Patterns related to the formatting of time zones.
 
+        .. note:: The format of the value returned may change between
+                  Babel versions.
+
         >>> Locale('en', 'US').zone_formats['fallback']
         u'%(1)s (%(0)s)'
         >>> Locale('pt', 'BR').zone_formats['region']
@@ -702,6 +729,9 @@ class Locale(object):
     def date_formats(self):
         """Locale patterns for date formatting.
 
+        .. note:: The format of the value returned may change between
+                  Babel versions.
+
         >>> Locale('en', 'US').date_formats['short']
         <DateTimePattern u'M/d/yy'>
         >>> Locale('fr', 'FR').date_formats['long']
@@ -713,6 +743,9 @@ class Locale(object):
     def time_formats(self):
         """Locale patterns for time formatting.
 
+        .. note:: The format of the value returned may change between
+                  Babel versions.
+
         >>> Locale('en', 'US').time_formats['short']
         <DateTimePattern u'h:mm a'>
         >>> Locale('fr', 'FR').time_formats['long']
@@ -724,6 +757,9 @@ class Locale(object):
     def datetime_formats(self):
         """Locale patterns for datetime formatting.
 
+        .. note:: The format of the value returned may change between
+                  Babel versions.
+
         >>> Locale('en').datetime_formats['full']
         u"{1} 'at' {0}"
         >>> Locale('th').datetime_formats['medium']
@@ -763,6 +799,9 @@ class Locale(object):
     def list_patterns(self):
         """Patterns for generating lists
 
+        .. note:: The format of the value returned may change between
+                  Babel versions.
+
         >>> Locale('en').list_patterns['start']
         u'{0}, {1}'
         >>> Locale('en').list_patterns['end']